java all type comments single-line line comments , multi-line line Comments , Documentation Comments in hindi

single-line line comments , multi-line line Comments , Documentation Comments in hindi

इस पोस्ट में आप जानेंगे :
1. single-line comment क्या होता है ?
2. multi-line comment क्या होता है ?
3. documentation comment क्या होता है
4. और साथ ही देखेंगे single-line line comments , multi-line line Comments , Documentation Comments के उदाहरण

कोड में कमेंट को शामिल करने का मुख्य उद्देश्य यह बताने के लिए किया जाता है कि कोड क्या कर रहा है |

जावा सिंगल और मल्टीलाइन दोनों तरह के कमेंट को सपोर्ट करता है

सभी करैक्टर जो कमेंट के अंदर होते हैं उन्हें जावा कंपाइलर इग्नोर कर देता है

single-line comment:

single-line comment बनाने के लिए आप जिन करैक्टर या word या सेंटेंस को कमेंट करना चाहते हैं उन प्रत्येक लाइन को two forward slashes के साथ शुरू करना होगा यहां पर प्रत्येक लाइन का मतलब यह है कि unwrap स्थित में करैक्टर या word या सेंटेंस एडिटर को मिनिमाइज करने पर नई लाइन पर नहीं आना चाहिए बल्कि होरिजेंटल बार के द्वारा छुपे हुए वर्ड सेंटेंस करेक्टर आज को देखा जा सके |

// यह एक सिंगल लाइन कमेंट है।
x = 5;//यह कोड के बाद एक सिंगल लाइन कमेंट है।

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

Multi-Line Comments:

जावा ऐसे कमेंट (comments) को भी सपोर्ट करता है जो कई लाइनों(lines) का हो सकता है

आप इस तरह के कमेंट को एक forward slash (/) तथा उसके तुरंत बाद asterisk (*) लगा कर शुरू कर सकते हैं और इस तरह के कमेंट का अंत asterisk और उसके तुरंत बाद forward slash (/) के साथ कर सकते हैं इनके बीच लिखे गया टेक्स्ट चाहे कितने भी लाइन का हो कंपाइलर इग्नोर कर देगा

उदाहरण

/* 

 यह भी कई लाइनों से मिलकर बना हुआ  

एक Multi-line  comment    है । 

*/

ध्यान दें कि java nested multi-line comments को सपोर्ट नहीं करता है, हालांकि आप मल्टीलाइन कमेंट के अंदर single-line comment को nest कर सकते हैं |

इस प्रकार से:

/* 
यह भी कई लाइनों से मिलकर बना हुआ  
एक Multi-line  comment    है । 
//मैं multi-line  के अंदर valid single-line comment  हूं
*/

nested multi-line comments मतलब एक multi-line comment के अंदर दूसरा multi-line comment को लिखना|

इस प्रकार से:

/* 
यह भी कई लाइनों से मिलकर बना हुआ  
एक Multi-line  comment    है । 
/*   यह कमेंट  जावा में  valid  
नहीं है
*/
*/

अतिरिक्त जानकारी:

Multi-Line comment का दूसरा नाम Block comment भी है|

Documentation Comments :

Documentation comment special type का कमेंट होता है जोकि muti-line comments की तरह ही दिखता है | लेकिन difference यह है कि यह आपके source code का external documentation GENERATE करता है|

यह forward slash तथा इसके तुरंत बाद double asterisk (**) के साथ शुरू होता है व asterisk तथा तुरंत बाद forward slash के साथ end होता है|

उदाहरण के लिए

/**  यह DOCUMENTATION COMMENT है */
/**  यह भी documentation  comment 
है ।
*/

Javadoc एक tool है जो JDK के साथ आता है, और इसका उपयोग HTML format मैं Java code document, Java source code से generate करने के लिए किया जाता है जिसके लिए predefine format मैं documentation की आवश्यकता होती है|

जब documentation comment दो से ज्यादा asterisk के साथ शुरू होता है, तो Javadoc मानता है कि आप comment के around source code मे बॉक्स बनाना चाहते हैं| यह आसानी से extra asterisk को अनदेखा कर देता है|

/**********************
 यहां से method  शुरू होगा
***********************/

यह DOCUMENTATION के लिए text को इसी तरह " यहां से method शुरू होगा" बनाए रखेगा