जावा में टिप्पणियाँ कैसे लिखें

जब आप कोडिंग कर रहे होते हैं, तो आपके दिमाग में पहली बात यह होगी कि कंप्यूटर आपके द्वारा लिखे गए कोड को कैसे प्रोसेस करता है। हालांकि, यह सोचना भी आवश्यक है कि लोग आपके कोड को कैसे पढ़ेंगे।

चाहे आप किसी टीम के साथ किसी प्रोजेक्ट पर काम कर रहे हों, या केवल स्वयं कुछ बना रहे हों, आपको अपने कोड को पर्याप्त रूप से दस्तावेज़ित करने के लिए कदम उठाने चाहिए। यहीं पर टिप्पणियाँ काम आती हैं।

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

यह ट्यूटोरियल चर्चा करेगा कि जावा में टिप्पणियाँ कैसे लिखें और कुछ सर्वोत्तम प्रथाओं के माध्यम से चलेगा जिनका उपयोग आप प्रभावी टिप्पणियाँ लिखने के लिए कर सकते हैं।

जावा टिप्पणियाँ

यदि आप प्रोग्रामिंग में नए हैं, तो आप खुद से पूछ सकते हैं: कोड पर टिप्पणी क्यों करनी चाहिए? कोड टिप्पणियाँ लिखना महत्वपूर्ण क्यों है इसके कुछ कारण हैं।

जब आप कोड लिख रहे होते हैं, तो यह स्वीकार करना महत्वपूर्ण है कि आपका कोड किसी न किसी द्वारा पढ़ा जाएगा, भले ही वह कोई आप ही हों। इसके अलावा, इस बात की कोई गारंटी नहीं है कि आपका कोड पढ़ने वाला व्यक्ति आपके द्वारा लिखे गए कोड को समझेगा।

यदि आप अकेले काम कर रहे हैं, तो टिप्पणियों के बिना कोड होना निराशाजनक महसूस हो सकता है और आपको यह पता लगाने में समय लग सकता है कि आपका कोड कैसे काम करता है। लेकिन अगर आप किसी टीम पर काम कर रहे हैं, तो टिप्पणियों का न होना और भी अधिक विघटनकारी हो सकता है। अन्य डेवलपर्स को आपके कोड के बारे में पूछना पड़ सकता है, जिससे मूल्यवान समय की खपत हो सकती है।

कुल मिलाकर, टिप्पणियाँ लिखने से कोड पढ़ना आसान हो जाता है। जब आप एक जटिल प्रक्रिया लिख रहे होते हैं, तो अपने कोड के बगल में कुछ सादा टेक्स्ट रखना सहायक हो सकता है जो कुछ कोड पंक्तियों के पीछे आपके इरादे को समझाता है। आपके द्वारा लिखी गई टिप्पणियाँ भविष्य के संदर्भ के लिए उपयोगी होंगी, खासकर यदि आप किसी प्रोजेक्ट पर अन्य डेवलपर्स के साथ काम कर रहे हैं।

81% प्रतिभागियों ने कहा कि बूटकैंप में भाग लेने के बाद उन्हें अपनी तकनीकी नौकरी की संभावनाओं के बारे में अधिक आत्मविश्वास महसूस हुआ। आज ही बूटकैंप से मिलान करें।

औसत बूटकैंप स्नातक ने बूटकैंप शुरू करने से लेकर पहली नौकरी खोजने तक कैरियर परिवर्तन में छह महीने से कम समय बिताया।

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

जावा टिप्पणी सिंटैक्स

जावा में, दो प्रकार की डॉक टिप्पणियाँ लिखी जा सकती हैं: सिंगल-लाइन टिप्पणियाँ और मल्टी-लाइन टिप्पणियाँ।

सिंगल-लाइन टिप्पणियाँ

सिंगल-लाइन टिप्पणियाँ, जिन्हें अक्सर इंलाइन टिप्पणियाँ कहा जाता है, कोड की एक पंक्ति के अंत में दिखाई देती हैं।

इंलाइन टिप्पणियों का उपयोग आमतौर पर कोड के छोटे हिस्सों को एनोटेट करने के लिए किया जाता है जो एक या दो पंक्तियों तक चलते हैं।

मान लीजिए हम एक प्रोग्राम लिख रहे हैं जो कंसोल पर संदेश It’s Friday प्रिंट करता है। हम अपने कोड पर नज़र रखने के लिए एक टिप्पणी लिखना चाहते हैं। यहाँ एक इंलाइन टिप्पणी का उदाहरण है जिसका हम उपयोग कर सकते हैं:

public class FridayMessage { public static void main(String[] args) { System.out.println("It's Friday!"); // prints "It's Friday" to the console } } 

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

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

मल्टी-लाइन टिप्पणियाँ

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

मल्टी-लाइन टिप्पणियाँ /* से शुरू होती हैं और */ से समाप्त होती हैं। यहाँ जावा स्रोत फ़ाइल में मल्टी-लाइन टिप्पणी का एक उदाहरण है:

/* यह एक मल्टी-लाइन टिप्पणी का उदाहरण है।

    नीचे दिया गया कोड कंसोल पर It’s Friday! प्रिंट करता है।

*/

public class FridayMessage { public static void main(String[[ args) { System.out.println("It's Friday!"); } } 

इस उदाहरण में, हमारी टिप्पणियाँ हमारे कोड की पहली तीन पंक्तियों पर दिखाई देती हैं।

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

परीक्षण के लिए कोड पर टिप्पणी करना

दस्तावेज़ीकरण की एक विधि के रूप में सेवा करने के अलावा, टिप्पणियों का उपयोग सॉफ्टवेयर विकास के परीक्षण और डीबगिंग चरणों के दौरान कोड को निष्पादित होने से रोकने के लिए भी किया जाता है। कोडर इसे कोड को कमेंट आउट करना कहते हैं।

मान लीजिए आप एक प्रोग्राम लिख रहे हैं जिसमें एक अपवाद उठाया गया है। आप अभी तक निश्चित नहीं हैं कि क्या गलत है, और इसलिए आप अपने कोड के हिस्से को कमेंट आउट करना चाहते हैं ताकि आप समस्या का स्रोत जान सकें। यहाँ टिप्पणियों का उपयोग करके कोड की एक पंक्ति को कमेंट आउट करने का एक उदाहरण है:

class FridayMessage { public static void main(String[[ args) { String day_of_the_week = "Friday"; // System.out.println("It's " ++ day_of_the_week); } } 

इस उदाहरण में, हमने System.out.println से शुरू होने वाली कोड की पंक्ति को कमेंट आउट कर दिया है। हमारे कोड ने एक त्रुटि लौटाई (क्योंकि हमने एक के बजाय दो ++ का उपयोग किया) और हमने त्रुटि का स्रोत पता लगाते समय कोड को कमेंट आउट कर दिया।

किसी प्रोग्राम के तर्क का विश्लेषण करते समय कोड को कमेंट आउट करना विशेष रूप से सहायक हो सकता है। इन स्थितियों में, आप अपने कोड के कई पुनरावृत्तियों को कमेंट आउट करना चाह सकते हैं जब तक कि आपको सबसे कुशल न मिल जाए। उस बिंदु के बाद, आप अपना पुराना कोड हटा सकते हैं।

आपको केवल परीक्षण और डीबगिंग चरणों के दौरान कोड को कमेंट आउट करना चाहिए। अंतिम प्रोग्राम में कमेंट आउट कोड छोड़ना अन्य डेवलपर्स के लिए भ्रमित करने वाला हो सकता है और कोड को पढ़ना अधिक कठिन बना देता है।

निष्कर्ष

जावा में, दो प्रकार की टिप्पणियाँ होती हैं: सिंगल-लाइन (या इंलाइन) टिप्पणियाँ और मल्टी-लाइन (या ब्लॉक) टिप्पणियाँ। इन टिप्पणियों का उपयोग आपके कोड को दस्तावेज़ित करने के लिए किया जाता है और सॉफ्टवेयर विकास के परीक्षण और डीबगिंग चरणों के दौरान आपकी सहायता के लिए भी किया जा सकता है।

अपने कोड पर टिप्पणी करने के लिए समय निकालने से आपका काम आपके लिए और किसी और के लिए अधिक पठनीय हो जाएगा जो आपके कोड को पढ़ रहा हो। और अंत में, याद रखें कि सबसे अच्छी टिप्पणियाँ वे हैं जो आपके कोड के पीछे के इरादे को समझाती हैं।

अब आप जावा में एक प्रो की तरह टिप्पणियाँ लिखना शुरू करने के लिए तैयार हैं!