जावा कोड में टिप्पणियों का उपयोग कैसे करें

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

आमतौर पर, कोड टिप्पणियां "कार्यान्वयन" टिप्पणियां हैं जो व्याख्या करती हैं सोर्स कोड, जैसे कि कक्षाओं, इंटरफेस, विधियों और क्षेत्रों का वर्णन। ये आम तौर पर जावा कोड के ऊपर लिखी गई लाइनों के एक जोड़े हैं या स्पष्ट करते हैं कि यह क्या करता है।

एक अन्य प्रकार की जावा टिप्पणी एक जावाडॉक टिप्पणी है। जावाडॉक टिप्पणियाँ कार्यान्वयन टिप्पणियों से वाक्य रचना में थोड़ा भिन्न होती हैं और जावा HTML प्रलेखन उत्पन्न करने के लिए प्रोग्राम javadoc.exe द्वारा उपयोग की जाती हैं।

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

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

कार्यान्वयन टिप्पणियाँ दो अलग-अलग स्वरूपों में आती हैं:

• लाइन टिप्पणियाँ: एक पंक्ति टिप्पणी के लिए, "//" टाइप करें और अपनी टिप्पणी के साथ दो फ़ॉरवर्ड स्लैश का अनुसरण करें। उदाहरण के लिए:

   // यह एक एकल पंक्ति टिप्पणी है
  int guessNumber = (int) (Math.random (* * 10); 

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

  •  // यह एक एकल पंक्ति टिप्पणी है
    // int अनुमाननंबर = (इंट) (गणित। आयामी () * 10); 

    आप पंक्ति टिप्पणी का अंत करने के लिए दो फ़ॉरवर्ड स्लैश का भी उपयोग कर सकते हैं:

  •  // यह एक एकल पंक्ति टिप्पणी है
    int guessNumber = (int) (Math.random (* * 10); // लाइन टिप्पणी का अंत 

• टिप्पणियाँ ब्लॉक करें: ब्लॉक टिप्पणी शुरू करने के लिए, "/ *" टाइप करें। फ़ॉरवर्ड स्लैश और तारांकन के बीच सब कुछ, भले ही यह एक अलग लाइन पर हो, एक टिप्पणी के रूप में व्यवहार किया जाता है जब तक कि अक्षर "* /" टिप्पणी को समाप्त नहीं करते हैं। उदाहरण के लिए:

   /* इस 
  है 
  ए
  खंड मैथा
  टिप्पणी
  */
  / * तो यह है * /
  

अपने जावा एपीआई दस्तावेज़ करने के लिए विशेष Javadoc टिप्पणियों का उपयोग करें। Javadoc JDK के साथ शामिल एक उपकरण है जो स्रोत कोड में टिप्पणियों से HTML प्रलेखन उत्पन्न करता है।

में एक Javadoc टिप्पणी

।जावा

/**

*/

*

इन टिप्पणियों को सीधे उस विधि, वर्ग, निर्माता या किसी अन्य जावा तत्व के ऊपर रखें जिसे आप दस्तावेज़ करना चाहते हैं। उदाहरण के लिए:

// myClass.java
/**
* अपनी कक्षा का वर्णन करते हुए इसे एक सारांश वाक्य बनाएँ।
* यहाँ एक और लाइन है।
*/
जनताकक्षा मेरी कक्षा
{
...
}

Javadoc में विभिन्न टैग शामिल होते हैं जो नियंत्रित करते हैं कि दस्तावेज़ कैसे उत्पन्न होता है। उदाहरण के लिए,

@param

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

कई अन्य टैग Javadoc में उपलब्ध हैं, और यह आउटपुट को नियंत्रित करने में मदद करने के लिए HTML टैग का भी समर्थन करता है। अधिक विस्तार के लिए अपने जावा प्रलेखन को देखें।

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

   /* इस 
  है
  / * यह ब्लॉक टिप्पणी पहली टिप्पणी को समाप्त करती है * /
  ए
  खंड मैथा
  टिप्पणी
  */