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

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

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

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

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

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

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

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

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

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

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

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

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

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

जावा में, दो प्रकार की दस्तावेज़ टिप्पणियाँ लिखी जा सकती हैं:एकल-पंक्ति टिप्पणियाँ और बहु-पंक्ति टिप्पणियाँ।

एकल-पंक्ति टिप्पणियाँ

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

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

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

पब्लिक क्लास फ्राइडेमैसेज {सार्वजनिक स्थैतिक शून्य मुख्य (स्ट्रिंग [] args) { System.out.println ("यह शुक्रवार है!"); // कंसोल पर "इट्स फ्राइडे" प्रिंट करता है }}

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

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

बहु-पंक्ति टिप्पणियाँ

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

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

/* यह एक बहु-पंक्ति टिप्पणी का उदाहरण है।

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

*/

पब्लिक क्लास फ्राइडेमैसेज {सार्वजनिक स्थैतिक शून्य मुख्य (स्ट्रिंग [[आर्ग्स) {System.out.println ("यह शुक्रवार है!"); }} 

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

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

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

 मान लीजिए कि आप एक प्रोग्राम लिख रहे हैं जिसने अपवाद उठाया है। आप अभी तक सुनिश्चित नहीं हैं कि क्या गलत है, और इसलिए आप समस्या के स्रोत का पता लगाने में मदद करने के लिए अपने कोड के हिस्से पर टिप्पणी करना चाहते हैं। कोड की एक पंक्ति पर टिप्पणी करने के लिए उपयोग की जा रही टिप्पणियों का एक उदाहरण यहां दिया गया है:
 
 
 क्लास फ्राइडेमैसेज {सार्वजनिक स्थैतिक शून्य मुख्य (स्ट्रिंग [[आर्ग्स) {स्ट्रिंग दिन_ऑफ_द_वीक ="शुक्रवार"; // System.out.println ("यह" ++ day_of_the_week है); }} 

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

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

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

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

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

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