लोड हो रहा है...

Java में Javadoc

विधि को विशेष टिप्पणी से दस्तावेज़ करिए ताकि पाठक और टूल देख सकें वह क्या लेती है और क्या लौटाती है। Yard.java में विधि add लिखिए जो int x और int y लेती है और उनका योग लौटाती है। ब्लॉक /** */ सीधे add के ऊपर रखिए। उस ब्लॉक के अंदर एक छोटी वाक्य में काम बताइए, फिर हर पैरामीटर को @param से और परिणाम को @return से टैग करिए। main में add(10, 2) छापिए। javac Yard.java से कंपाइल करिए और java Yard चलाइए। स्क्रीन पर 12 दिखना चाहिए। नामकरण नियम अगले पृष्ठ के लिए छोड़ दीजिए — यह पाठ दस्तावेज़ टिप्पणी का आकार है, नाम चुनना नहीं।

विधि के ऊपर /** रखिए

debugging पृष्ठ ने गलत sum खोजने के लिए मान छापे। यह पृष्ठ साफ़ विधि के ऊपर दस्तावेज़ टिप्पणी लिखता है। Yard.java खोलिए। पब्लिक क्लास नाम Yard रखिए। बचे println debug लेबल जो दस्तावेज़ कहानी दबाएँ हटा दीजिए, बचे equals / == डेमो, बचे Machine horn फ़ाइलें, और कोई भी कीबोर्ड Scanner भी हटा दीजिए। प्रोग्राम टाइपिंग का इंतज़ार न करे। इस डेमो के लिए import लाइन की ज़रूरत नहीं।
Yard के अंदर एक छोटी विधि और छोटा main रखिए। दस्तावेज़ ब्लॉक ठीक उसी विधि के ऊपर बैठना चाहिए जिसका वह वर्णन करता है। बंद */ और विधि पंक्ति के बीच खाली पंक्ति ठीक है। ब्लॉक को main के अंदर छिपाएँ नहीं। ब्लॉक को विधि के शरीर के नीचे न रखिए।
टिप्पणी की शुरुआत स्लैश के बाद दो सितारों से लिखिए:
/**
फिर एक सादा वाक्य लिखिए कि add क्या करती है। फिर टैग लिखिए। बंद करिए:
*/
विधि स्वयं साधारण Java रहती है:
static int add(int x, int y) {
return x + y;
}
Javadoc return के काम करने का तरीका नहीं बदलता। वह पाठक को बताता है कि शरीर की हर पंक्ति पढ़ने से पहले विधि क्या वादा करती है।

Yard add with Javadoc tags

java

public class Yard {
    /**
     * Adds two numbers.
     * @param x first number
     * @param y second number
     * @return the sum of x and y
     */
    static int add(int x, int y) {
        return x + y;
    }

    public static void main(String[] args) {
        System.out.println(add(10, 2));
    }
}

उस फ़ोल्डर से जहाँ Yard.java है javac Yard.java चलाइए। जब कोष्ठक, ब्रेसिज़ और सेमीकोलन मेल खाएँ, javac अपनी कोई पंक्ति नहीं लिखता। फिर java Yard चलाइए — java Yard.java नहीं। रन कमांड से .java अंत हटा दीजिए। फ़ाइल में एक पब्लिक क्लास रखिए ताकि नाम Yard से मेल खाए।
स्क्रीन 12 दिखाती है। रन एक बार घुमाइए। Java Yard.main से शुरू होता है। कॉल add(10, 2) विधि में जाता है जहाँ x दस और y दो रखता है। return पंक्ति बारह लौटाती है। System.out.println वह संख्या लिखता है। Javadoc ब्लॉक खुद नहीं छापता। ब्लॉक पाठकों और दस्तावेज़ टूल के लिए है। इस पृष्ठ का शुरुआती प्रमाण अभी भी साफ़ टिप्पणी के बाद सही रन है।
टिप्पणी ब्लॉक पढ़िए और साथ में विधि के सिग्नेचर को देखिए। वाक्य Adds two numbers. काम return x + y; से मेल खाता है। पंक्ति @param x first number पहला पैरामीटर नाम देती है। पंक्ति @param y second number दूसरा पैरामीटर नाम देती है। पंक्ति @return the sum of x and y परिणाम नाम देती है। टैग की वर्तनी सटीक रखिए: @param और @return में @ चिह्न और लैटिन अक्षर हैं।
अगर अभी भी debugging फ़ाइल से x=10 और y=2 फिर 8 दिखे, Javadoc शिक्षण फ़ाइल पर जाइए और फिर java Yard चलाइए। अगर केवल // Adds two numbers. विधि के ऊपर लिखें तो आपने साधारण पंक्ति टिप्पणी लिखी, Javadoc ब्लॉक नहीं। दो-सितारा रूप /** रखिए ताकि ब्लॉक दस्तावेज़ हो, एक-पंक्ति नोट नहीं।
स्क्रीन देखते हुए नियम ज़ोर से कहिए: विधि के ऊपर दस्तावेज़ करिए, पैरामीटर टैग करिए, लौटाने वाला मान टैग करिए, फिर कंपाइल और चलाकर साबित करिए कि विधि अभी भी काम करती है। इस पृष्ठ पर लंबी नामकरण व्याख्यान मत गढ़िए। नामकरण अगले पाठ की प्रतीक्षा करता है।

टैग का नक्शा पढ़िए

एक छोटी तालिका उन तीन टुकड़ों को रखती है जो आपने टिप्पणी में टाइप किए। शुरुआत /** */ दस्तावेज़ ब्लॉक चिह्नित करती है। @param एक पैरामीटर नाम का वर्णन करता है। @return वह मान बताता है जो विधि लौटाती है। विधि नाम add और कॉल add(10, 2) रखिए ताकि स्क्रीन एक साफ़ संख्या रहे।
तालिका इस पृष्ठ का छोटा नक्शा है। पहले ब्लॉक रखिए। फिर इनपुट और आउटपुट टैग करिए। फिर javac और java Yard से जाँचिए। अनुमान मत लगाइए कि हर टिप्पणी शैली Javadoc है। जब तक पता न हो कि प्रोग्राम अभी भी 12 छापता है, ब्लॉक मिटाना छोड़ दीजिए।

📊 Beginner Javadoc pieces on Yard

Piece	What it does
`/** */`	Marks a documentation comment above a method
`@param`	Describes one parameter by name
`@return`	Describes the value the method returns

तालिका को शिक्षण फ़ाइल के पास रखिए जब संपादन करें। फ़ाइल में @param x की ओर इशारा करिए, फिर सिग्नेचर में int x की ओर। @param y की ओर इशारा करिए, फिर int y की ओर। @return की ओर इशारा करिए, फिर return पंक्ति की ओर। यह मिलान खेल एक ही चक्कर में पूरी शुरुआती बात है। जो टूल Javadoc पढ़ते हैं वे इन्हीं टैग को खोजते हैं। मानव पाठक जब बाद में विधि का शरीर बढ़े तब भी उसी नक्शे का उपयोग करते हैं।
अगर बचे debugging डेमो अभी पास हों, उन्हें इतिहास की तरह रखिए। इस पाठ के लिए Javadoc शिक्षण फ़ाइल चलाइए ताकि स्क्रीन add से 12 दिखाए, शिकार वाली लेबल x= पंक्तियाँ नहीं। अगर javac डुप्लिकेट पब्लिक क्लास की शिकायत करे, केवल Yard को public रखिए।

साधारण // Javadoc नहीं है

जो पंक्ति // से शुरू होती है वह फ़ाइल पढ़ने वाले के लिए नोट है। उपयोगी है, और इस कोर्स ने पहले पंक्ति टिप्पणियाँ इस्तेमाल कीं। यह वह दस्तावेज़ ब्लॉक आकार नहीं जो यह पृष्ठ सिखाता है। विधि का Javadoc /** से शुरू होता है और */ पर खत्म होता है। टैग @param और @return उसी ब्लॉक के अंदर बैठते हैं।
अगर विधि के नीचे अन्य कथनों के बाद सादा स्ट्रिंग रखें, वह स्ट्रिंग विधि दस्तावेज़ नहीं बनती। दस्तावेज़ ब्लॉक विधि के ऊपर चिपकी टिप्पणी होना चाहिए। ब्लॉक को add के पास कसकर रखिए। main को नकली दस्तावेज़ नाटक से खाली रखिए। main में कॉल लौटे योग का सामान्य प्रिंट रहता है।
जब टिप्पणी गलत हो लेकिन विधि का शरीर सही हो, javac फिर भी सफल हो सकता है और java Yard फिर भी 12 छाप सकता है। इसीलिए यह पृष्ठ चाहता है कि आप टिप्पणी और सिग्नेचर साथ पढ़ें, केवल स्क्रीन नहीं। स्क्रीन गणित साबित करती है। टिप्पणी अनुबंध को लेबल करती है।

debugging प्रिंट से तुलना

debugging पृष्ठ पर println ने जवाब दिया कि जब sum गलत लगे तो आपकी संख्याएँ वास्तव में क्या हैं। इस पृष्ठ पर Javadoc जवाब देता है कि शरीर में घुसने से पहले add क्या वादा करती है। आप अभी भी Yard.java कंपाइल करते हैं और java Yard चलाते हैं। नए टोकन विधि के ऊपर /**, @param, और @return हैं।
debugging ने साधारण आउटपुट को टॉर्च की तरह इस्तेमाल किया। Javadoc संरचित टिप्पणी को विधि के दरवाज़े पर लेबल की तरह इस्तेमाल करता है। जब लेबल पैरामीटर और लौटाने वाले मान से मेल खाए, पाठक कम अनुमान लगाते हैं। जब लेबल गायब हो, प्रोग्राम फिर भी चल सकता है — दस्तावेज़ की आदत अभी भी गायब है।
अगर बची debugging फ़ाइल अभी खुली है, आप x=10, y=2, और पुराना sum देख सकते हैं। Javadoc फ़ाइल पर जाइए ताकि main add(10, 2) छापे और विधि दस्तावेज़ ब्लॉक ले जाए। नामकरण शैली की व्याख्यान इस पृष्ठ से बाहर रखिए। कीबोर्ड इनपुट इस पृष्ठ से बाहर रखिए।

नामकरण से पहले

आप add के ऊपर /** */ रख सकते हैं, @param x, @param y, और @return टैग कर सकते हैं, और java Yard के बाद अभी भी 12 देख सकते हैं। रखी डेमो के लिए Yard.java कंपाइल कर java Yard चलाइए। टिप्पणी ने पाठकों को अनुबंध बताया। अगला पृष्ठ नामकरण है, जहाँ आप जो लिखते हैं उसके लिए साफ़ नाम चुनते हैं।
दस्तावेज़ किए add डेमो को साफ़ टिप्पणी-плюс-रन जोड़ी के लिए रखिए। दस्तावेज़ का अभ्यास करते समय debugging फ़ाइलें इस पृष्ठ से बाहर रखिए। naming फ़ाइलें उस पाठ तक इस पृष्ठ से बाहर रखिए। ये तीन आदतें आगे बढ़ने से पहले चौकी हैं। जब टैग सिग्नेचर से मेल खाएँ और स्क्रीन 12 दिखाए, Javadoc ने इस पाठ का काम किया और आप नामकरण वाले अगले विषय के लिए तैयार हैं।
फ़ोल्डर पर एक आखिरी चक्कर: एक पब्लिक Yard, एक दस्तावेज़ add, main में एक प्रिंट, कोई कीबोर्ड इंतज़ार नहीं, कोई ज़बरदस्ती नामकरण नियम नहीं। खुली डेमो पर एक बार और javac Yard.java और java Yard चलाइए। अगर स्क्रीन अभी भी 12 दिखाती है और टिप्पणी अभी भी add के ऊपर @param और @return के साथ बैठी है, दस्तावेज़ आकार मज़बूत है और कोर्स अगले पृष्ठ पर नामकरण पर जा सकता है। एक विधि पर एक साफ़ दस्तावेज़ ब्लॉक चुनिए ताकि हर पढ़ना वही नक्शा सिखाए।

🧠 अपने ज्ञान की परीक्षा करें

शुरू करने के लिए तैयार

अपने ज्ञान की परीक्षा करें

इस इंटरैक्टिव क्विज़ के साथ अपनी चुनौती लें और देखें कि आप विषय को कितनी अच्छी तरह समझते हैं

❓

प्रश्न

🎯

70%

पास करने के लिए

♾️

∞

समय

🔄

∞

प्रयास

📝 निर्देश

हर प्रश्न को ध्यान से पढ़ें
हर प्रश्न के लिए सबसे अच्छा उत्तर चुनें
आप जितनी बार चाहें क्विज़ दोबारा दे सकते हैं
आपकी प्रगति शीर्ष पर दिखाई जाएगी