मैं एक परियोजना छोड़ने वाला हूं, और इससे पहले कि मैं अपने बॉस को दस्तावेज़ कोड के लिए कहूं (मैंने बहुत अच्छी तरह से दस्तावेज नहीं किया है)। यह बड़ी बात नहीं है, यह परियोजना बहुत जटिल नहीं है। लेकिन मुझे अपने दस्तावेज़ में ऐसी जगह मिल रही हैं जहाँ मैं कहना चाहूँगा, "लाइन XYZ पर ध्यान दें कि ऐसा-और-ऐसा होता है।"
इस मामले में, किसी विशिष्ट पंक्ति संख्या को संदर्भित करने का कोई मतलब नहीं है, क्योंकि कोड की एक पंक्ति को जोड़ने या हटाने से दस्तावेज़ को तुरंत समाप्त कर दिया जाएगा। क्या कोड संख्या के बिना किसी विशिष्ट पंक्ति को संदर्भित करने के लिए कुछ सर्वोत्तम प्रथा है?
मैंने कोड को टिप्पणियों के साथ समेटना माना है:
/* linetag 38FECD4F */
जहाँ "38FECD4F" उस विशिष्ट लाइन के लिए कुछ अनोखा टैग है। फिर मैं दस्तावेज़ीकरण में रख सकता हूं, "लाइन पर '38FECD4F' टैग किया गया है, ध्यान दें कि ऐसा-और-ऐसा होता है।"
कोई अन्य विचार? मुझे ऐसा लगता है कि आम तौर पर कोड इकाइयों को समग्र रूप से बेहतर बनाना बेहतर होता है, बल्कि उनके विशिष्ट भागों के बजाय, लेकिन इस विशेष परियोजना के मामले में प्रक्रियात्मक कोड के LONG swaths हैं, जिन्हें कभी भी छोटी इकाइयों में शामिल नहीं किया गया है।