"टिप्पणियाँ पुरानी हो जाती हैं।"
मैंने देखा है कि ऐसा अक्सर होता है यह जानने के लिए कि यह एक समस्या हो सकती है।
बात यह है, मुझे लगता है कि मैंने अपने पूरे करियर में दो या तीन पुरानी टिप्पणियों को देखा है।
मेरा मानना है कि ऐसे माहौल में काम करना पूरी तरह से संभव होना चाहिए जहां हर कोई टिप्पणियों का पर्याप्त ध्यान रखता है और उन्हें बनाए रखता है। आपके द्वारा संपादित किए जा रहे कोड के पास टिप्पणियों को देखने और उचित होने पर उन्हें अपडेट करने के लिए यह केवल एक छोटा सा अतिरिक्त प्रयास है। मामले में टिप्पणियाँ इतनी दूर हैं कि आप तुरंत उन्हें नोटिस नहीं करते हैं, वे वैसे भी खराब टिप्पणियां थीं, और उन्हें पहले स्थान पर नहीं जोड़ा जाना चाहिए (या कम से कम वहां नहीं)।
इसके अलावा आमतौर पर बयान के साथ कि टिप्पणियाँ पुरानी हो जाती हैं, इस कथन का अनुसरण करती है कि यह पठनीयता को कम करता है और लोगों को भ्रमित करता है। यह कुछ ऐसा है जो मैंने अभी तक अनुभव नहीं किया है। हर बार जब मैं आउट ऑफ़ डेट टिप्पणी करता हूं, तो मैं स्पष्ट रूप से देखता हूं कि क्या बदला है और नए कोड का प्रतिनिधित्व करने के लिए टिप्पणी को तदनुसार अपडेट करें, कुछ अतिरिक्त प्रयास के साथ।
Roehm et al द्वारा हाल ही में किया गया एक अध्ययन । 2012 निम्नलिखित देखता है:
21 प्रतिभागियों [28 में से] ने बताया कि उन्हें स्रोत कोड और इनलाइन टिप्पणियों से अपनी मुख्य जानकारी मिलती है जबकि केवल चार ने कहा कि प्रलेखन उनकी सूचना का मुख्य स्रोत है।
यह आपके संदेह के अनुरूप है कि कोड में टिप्पणी आमतौर पर अभी भी बहुत उपयोगी मानी जाती है। यह इंगित करता है कि पुरानी प्रलेखन और पुरानी टिप्पणियों के बीच एक स्पष्ट रेखा खींची जानी चाहिए ।
रोहम, टी।, टायर्क्स, आर।, कोस्चके, आर।, और मलेज, डब्ल्यू (2012, जून)। कैसे पेशेवर डेवलपर्स सॉफ्टवेयर समझाना ?. सॉफ्टवेयर इंजीनियरिंग पर 2012 के अंतर्राष्ट्रीय सम्मेलन की कार्यवाही में (पीपी। 255-265)। IEEE प्रेस।