कोड को सही ढंग से कैसे टिप्पणी करें

एक बार जब मैं आउटलेट के पास एक लैपटॉप के साथ दर्शकों में बैठा था, और उस समय एक पड़ोसी डेस्क पर एक प्रोग्रामिंग टेस्ट लिया गया था। मैंने उन सवालों के सार में तल्लीन नहीं किया जो छात्र और शिक्षक से बात करते थे, चलो उसे इवान इवानोविच कहते हैं। बातचीत बहुत शांत और शांत थी, लेकिन मैं एक टुकड़ा हड़पने में कामयाब रहा। शिक्षक ने टिप्पणियों के बारे में बात की (स्पष्ट रूप से कार्यक्रम ने आत्मसमर्पण किया, जिसमें टिप्पणियों की एक भी पंक्ति नहीं थी)। मेरी इस पल में दिलचस्पी थी और मैं सुनने लगा। यह देखा गया कि मुझे भी दिलचस्पी थी, शिक्षक ने एक व्याख्यान शुरू किया। नीचे उस छोटे से ज्ञान का टुकड़ा है जो मैंने इस 5 मिनट के व्याख्यान से सीखा था।

मैं तुरंत चेतावनी देना चाहूंगा कि यहां वर्णित कई चीजों के लिए स्पष्ट चीजें हैं, हालांकि, यह सामूहिक प्रोग्रामिंग (जब 2 या अधिक प्रोग्रामर कोड पर काम करते हैं) और छात्रों के लिए शुरुआती के लिए उपयोगी होगा। इसके अलावा, नीचे दिए गए सभी सुझावों में एक विकल्प है और केवल भाग में उपयोग किया जा सकता है।

मैंने यहां छात्रों को क्यों नियुक्त किया? वे, ऐसा लगता है, अकेले ऑफसेट के लिए कार्यक्रम पर काम कर रहे हैं! शिक्षक, जब वह कार्यक्रम को स्वीकार करता है, तो दूसरे डेवलपर को सही माना जाता है, जो आदर्श रूप से, एक छात्र की मदद के बिना, यह समझना चाहिए कि वहां क्या लिखा गया है और यह कैसे काम करता है।

टिप्पणियों के साथ तुरंत कोड कैसे लिखें

वास्तव में, उस व्याख्यान में टीडीडी (परीक्षण द्वारा संचालित विकास, परीक्षण के माध्यम से विकास) के सिद्धांत को निचले स्तर पर ले जाया गया था। मुझे याद नहीं है कि यह मूल में कैसे लग रहा था, लेकिन संक्षेप में "टिप्पणियों के साथ कोड की संरचना का वर्णन करें" । दो कोड को जोड़ने वाले प्रोग्राम कोड के उदाहरण (दृढ़ता से अतिरंजित, क्यों - नीचे) पर यह सिद्धांत इस तरह दिखाई देगा:

int main() { //      //      //    return 0; } 

और केवल जब टिप्पणियों से रूपरेखा तैयार होती है, तो क्या आपको ऐसा कोड लिखना चाहिए जो टिप्पणियों द्वारा वर्णित वर्णन को लागू करेगा।

 ... int main() { double a,b; //      cin>>a; cin>>b; //     double sum = a+b; //    cout<<sum; return 0; } 

जैसा कि ऊपर उल्लेख किया गया है, यह सिद्धांत अच्छी तरह से स्थापित टीडीडी का एक संशोधित सिद्धांत है। यह समझा जाना चाहिए कि टिप्पणियों से विचलन, परीक्षणों के तर्क से विचलन के विपरीत, गंभीर परिणाम नहीं देगा, ठीक है, जब तक कि आपको टिप्पणियों को फिर से लिखना न पड़े

अब "शुद्ध रूप से काल्पनिक" स्थिति की कल्पना करें, जब पहले से ही एक शानदार प्रोग्रामर द्वारा लिखित 200,000 लाइनों का एक कोड है , एक घुमावदार भारतीय और जिसमें एक भी टिप्पणी लाइन नहीं है। हालांकि, आपको इस कोड को समझने के लिए न केवल इस प्रोग्रामर को मारने की जरूरत है, बल्कि भविष्य में भी इसका साथ देना होगा। आपने इस कोड का भी पता लगा लिया है, और एक सभ्य व्यक्ति होने के नाते, आपने भविष्य की पीढ़ियों के लिए टिप्पणियों के साथ कोड को पूरक करने का फैसला किया है। लेकिन सवाल उठता है: कैसे?

मौजूदा कोड पर टिप्पणी कैसे करें

इस प्रश्न का उत्तर काफी सरल है: हम माता-पिता से बच्चे तक की कक्षाओं पर टिप्पणी करते हैं: कक्षा -> विधि -> विधि के अंदर कोड (यदि आवश्यक हो)।

यह सोचना तर्कसंगत होगा: और टिप्पणी करने की आवश्यकता नहीं है। दो मामलों में टिप्पणी करने की आवश्यकता नहीं है (उनमें से एक यह बताता है कि ऊपर दिए गए कोड का उदाहरण बहुत ही अतिरंजित क्यों था):

• स्पष्ट बातें। प्रपत्र की टिप्पणियां // अपनी अनुपस्थिति से अधिक नाराज काउंटर को इनिशियलाइज़ करती हैं
• एक टिप्पणी के साथ समझ से बाहर कोड जोड़ें / // कुछ भी समझ में नहीं आता

दूसरे बिंदु के बारे में, यह थोड़ा समझाने और एक उदाहरण देने के लायक है: कोडांतरक सी कोड की 100 लाइनें सम्मिलित करना! आप इसे देखें और एक टिप्पणी लिखें // कई bukaf! niasilil
उसके बाद, आपकी बर्खास्तगी के बाद जो व्यक्ति आपकी जगह पर आया, वह इस टिप्पणी को देखता है और ... यह बात है! वह इसका पता लगाने की कोशिश भी नहीं करेगा, और आपका यह रिकॉर्ड कोड के इस टुकड़े पर कलंक होगा जब तक कि इसे हटा नहीं दिया जाता (या तो कोड या टिप्पणी)।

अंत में

अंत में, मैं कह सकता हूं कि टिप्पणी लिखने की कला प्रोग्रामिंग की कला का एक अभिन्न हिस्सा है, इसलिए आपको टिप्पणियों को लिखने की आवश्यकता है , और कोई फर्क नहीं पड़ता कि यह कितना दयनीय लगता है, आपको उच्च-गुणवत्ता वाली टिप्पणियां लिखने की आवश्यकता है ।