27
मैं किसी और के कोड पर काम कर रहा हूं और महत्वपूर्ण संशोधन कर रहा हूं। (मैं इसे मूल रूप से उपयोग किए जाने वाले किसी भिन्न डेटाबेस का उपयोग करने के लिए परिवर्तित कर रहा हूं।) मैं जावाडोक टिप्पणियों में कैसे इंगित करता हूं कि मैं कोड का मूल लेखक नहीं हूं, लेकिन मैंने इसमें योगदान दिया है। क्या यह पहले से ही करने का एक साफ या मानक तरीका है? माई गुगलिंग मुझे यह समझने में मदद नहीं कर रही है।जब मैं किसी और के कोड को संशोधित करता हूं तो मैं जावाडोक को कैसे संशोधित करूं?
उदाहरण:
/**
* This class does some really awesome stuff.
*
* @author Steph the Great - Modified to use PostgreSQL instead of Derby;
* added comments to the code
*/
मैं भी मूल लेखक का नाम पता नहीं है, इसलिए सभी मैं नीचे रख सकते हैं अपने आप को है। । ।
मुझे बहुत तनाव नहीं मिलेगा। यदि आपको लगता है कि मूल लेखकों से अपने काम को अलग करना महत्वपूर्ण है तो आप अपने परिवर्तनों को हाइलाइट करने के लिए इनलाइन टिप्पणियों का उपयोग कर सकते हैं या सिर्फ "संशोधित करने के लिए ... द्वारा ..." या जो कुछ भी आपको सुइट करता है, उसे जवाडोक में एक टिप्पणी जोड़ें। । आम तौर पर लोग कोड में परिवर्तनों के बारे में परेशान हो जाते हैं अगर कोई इसे मिटा देता है और टिप्पणी नहीं करता है, इस प्रकार मूल लेखक को खराब प्रोग्रामर के रूप में लेबल किया जाता है। जब तक आप यह कहने के लिए कुछ जोड़ते हैं कि आपने इसे बदल दिया है और मूल लेखक नहीं हैं तो आपको ठीक होना चाहिए।और कई मामलों में, इससे कोई फर्क नहीं पड़ता कि आप नहीं करते हैं :-) –
drekka