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