Java कोड में विभिन्न प्रकार की टिप्पणियां (Comments) कैसे जोड़ें?

Java टिप्पणियां (Comments) वे स्टेटमेंट्स हैं जो कंपाइलर और इंटरप्रेटर द्वारा निष्पादित नहीं की जातीं। टिप्पणियों का उपयोग वेरिएबल, मेथड, क्लास या किसी स्टेटमेंट के बारे में जानकारी प्रदान करने के लिए किया जा सकता है। इसका उपयोग किसी प्रोग्राम कोड को कुछ समय के लिए छिपाने (डिसेबल करने) के लिए भी किया जा सकता है।

Java टिप्पणियों के प्रकार

Java में तीन प्रकार की टिप्पणियां होती हैं:

• सिंगल लाइन टिप्पणी (Single Line Comment)
• मल्टी-लाइन टिप्पणी (Multi-line Comment)
• डॉक्यूमेंटेशन टिप्पणी (Documentation Comment)

1. सिंगल लाइन टिप्पणी (Single Line Comment)

सिंगल लाइन टिप्पणी // से शुरू होती है और लाइन के अंत पर समाप्त होती है।

उदाहरण 1

public class SingleLineComment {
    public static void main(String[] args) {
        // कंसोल में आउटपुट प्रिंट करने के लिए
        System.out.println("Welcome to Tutorials Point");
    }
}

आउटपुट

Welcome to Tutorials Point

2. मल्टी-लाइन टिप्पणी (Multi-line Comment)

मल्टी-लाइन टिप्पणी /* से शुरू होती है और */ पर समाप्त होती है, जो कई लाइनों तक फैली हो सकती है।

उदाहरण 2

public class MultiLineComment {
    public static void main(String[] args) {
        /* कंसोल में आउटपुट प्रिंट करने के लिए
           Welcome to Tutorials Point */
        System.out.println("Welcome to Tutorials Point");
    }
}

आउटपुट

Welcome to Tutorials Point

3. डॉक्यूमेंटेशन टिप्पणी (Documentation Comment)

डॉक्यूमेंटेशन शैली की टिप्पणियां /** से शुरू होती हैं और */ पर समाप्त होती हैं, जो कई लाइनों तक फैली हो सकती हैं। डॉक्यूमेंटेशन टिप्पणियां क्लास, इंटरफेस, मेथड या फील्ड डेफिनिशन के ठीक पहले आनी चाहिए। इनका उपयोग Javadoc टूल द्वारा API डॉक्यूमेंटेशन जनरेट करने के लिए किया जाता है।

उदाहरण 3

/**
 * यह एक डॉक्यूमेंटेशन टिप्पणी है।
 * यह क्लास Java में डॉक्यूमेंटेशन टिप्पणी के उपयोग को दिखाने के लिए लिखी गई है।
 * यह प्रोग्राम कंसोल में "Welcome to Tutorials Point" टेक्स्ट प्रदर्शित करता है।
 */
public class DocumentationComment {
    public static void main(String args[]) {
        System.out.println("Welcome to Tutorials Point");
    }
}

आउटपुट

Welcome to Tutorials Point

Javadoc टैग्स (आम तौर पर उपयोग किए जाने वाले)

डॉक्यूमेंटेशन टिप्पणी के साथ Javadoc टैग्स का उदाहरण

/**
 * दो संख्याओं को जोड़ता है।
 *
 * @param a पहली संख्या
 * @param b दूसरी संख्या
 * @return दोनों संख्याओं का योग
 * @throws IllegalArgumentException यदि कोई संख्या ऋणात्मक है
 * @since 1.0
 */
public int add(int a, int b) {
    if (a < 0 || b < 0) {
        throw new IllegalArgumentException("Negative numbers not allowed");
    }
    return a + b;
}

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