मैं सोर्स कोड पर टिप्पणी करने और सॉफ्टवेयर उत्पादों के दस्तावेजीकरण का हिमायती हूं। यह मेरा व्यक्तिगत अनुभव और अवलोकन है कि जिस सोर्स कोड पर कठोर टिप्पणी की जाती है, उस पर काम करने से मुझे अलग-अलग तरीकों से मदद मिली है, जब मुझे सॉफ्टवेयर विकसित करना है या इसे बनाए रखना है।
हालाँकि एक और शिविर है जो कहता है कि टिप्पणी करना अंततः बेकार है या इसका मूल्य संदिग्ध है। टिप्पणी के बिना कोडिंग के कई समर्थकों का तर्क है कि:
- यदि कोड का एक टुकड़ा अच्छी तरह से लिखा गया है, तो यह आत्म व्याख्यात्मक है और इसलिए टिप्पणी करने की आवश्यकता नहीं है
- यदि कोड का एक टुकड़ा स्व-व्याख्यात्मक नहीं है, तो इसे रिफैक्ट करें और इसे स्वयं-व्याख्यात्मक बनाएं ताकि इसे इन टिप्पणियों की आवश्यकता न हो
- आपका टेस्ट सूट आपका लाइव डॉक्यूमेंटेशन है
- समय के साथ कोड और टिप्पणियां सिंक से बाहर हो जाती हैं और यह सिरदर्द का एक और स्रोत बन जाता है
- एजाइल का कहना है कि वर्किंग कोड प्रलेखन के ढेर से ज्यादा महत्वपूर्ण है, इसलिए हम सुरक्षित रूप से टिप्पणी लिखने को अनदेखा कर सकते हैं
मेरे लिए यह सिर्फ हठधर्मिता है। फिर से, मेरा व्यक्तिगत अवलोकन यह रहा है कि स्मार्ट और अनुभवी डेवलपर्स की टीमों द्वारा लिखा गया सॉफ्टवेयर अंत में काफी मात्रा में कोड के साथ समाप्त होता है जो कि आत्म-व्याख्यात्मक नहीं है।
फिर से, जावा एपीआई, कोको एपीआई, एंड्रॉइड एपीआई, आदि बताते हैं कि यदि आप गुणवत्ता प्रलेखन को लिखना और बनाए रखना चाहते हैं, तो यह संभव है।
यह सब कहने के बाद, पेशेवरों और पेशेवरों के विपक्ष के बारे में बातचीत और स्रोत कोड पर टिप्पणी करना जो व्यक्तिगत मान्यताओं पर आधारित हैं, आमतौर पर अच्छी तरह से समाप्त नहीं होते हैं और कोई संतोषजनक निष्कर्ष नहीं निकालते हैं।
जैसे कि मैं सॉफ्टवेयर के प्रलेखन के प्रभावों के बारे में अकादमिक पत्रों और अनुभवजन्य अध्ययनों की तलाश कर रहा हूं, विशेष रूप से स्रोत कोड पर टिप्पणी कर रहा हूं, इसकी गुणवत्ता और स्थिरता के साथ-साथ टीम की उत्पादकता पर इसके प्रभाव।
क्या आप इस तरह के लेखों पर अड़ गए हैं और उनका परिणाम क्या रहा है, यदि कोई है तो