हम इस ट्यूटोरियल में सीखने वाले है कि जावा डॉक्यूमेंटेशन कमैंट्स (Java documentation Comments in Hindi) और हम इसे कैसे इस्तमाल कर सकते हैं?
Table of Contents
जावा भाषा तीन प्रकार की टिप्पणियों का समर्थन करती है –
| Sr.No. | Comment & Description |
| 1 | /* text */कंपाइलर/* to */ तक सब कुछ अनदेखा करता है। |
| 2 | //textकंपाइलर // से लाइन के अंत तक सब कुछ अनदेखा करता है। |
| 3 | /** documentation */यह एक प्रलेखन टिप्पणी है और सामान्य तौर पर इसे डॉक्टर टिप्पणी कहा जाता है। स्वचालित रूप से जेनरेट किए गए दस्तावेज़ तैयार करते समय जेडीके जावाडोक टूल डॉक्टर टिप्पणियों का उपयोग करता है। |
यह अध्याय Javadoc की व्याख्या करने के बारे में है। हम देखेंगे कि जावा कोड के लिए उपयोगी दस्तावेज तैयार करने के लिए हम जावाडॉक का उपयोग कैसे कर सकते हैं।
जावाडॉक क्या है? (What is Javadoc?)
Javadoc एक ऐसा टूल है जो JDK के साथ आता है और इसका उपयोग Java सोर्स कोड से HTML फॉर्मेट में Java कोड डॉक्यूमेंटेशन जेनरेट करने के लिए किया जाता है, जिसके लिए पूर्वनिर्धारित फॉर्मेट में डॉक्यूमेंटेशन की आवश्यकता होती है।
निम्नलिखित एक सरल उदाहरण है जहां अंदर की पंक्तियाँ /*….*/ Java बहु-पंक्ति टिप्पणियाँ हैं। इसी तरह // के आगे आने वाली लाइन जावा सिंगल-लाइन कमेंट है।
Example
/**
* The HelloWorld program implements an application that
* simply displays “Hello World!” to the standard output.
*
* @author Zara Ali
* @version 1.0
* @since 2014-03-31
*/
public class HelloWorld {
public static void main(String[] args) {
// Prints Hello, World! on standard output.
System.out.println(“Hello World!”);
}
}
आप विवरण भाग के अंदर आवश्यक HTML टैग शामिल कर सकते हैं। उदाहरण के लिए, निम्न उदाहरण शीर्षक के लिए <h1>….</h1> का उपयोग करता है और <p> का उपयोग पैराग्राफ ब्रेक बनाने के लिए किया गया है –
Example
/**
* <h1>Hello, World!</h1>
* The HelloWorld program implements an application that
* simply displays “Hello World!” to the standard output.
* <p>
* Giving proper comments in your program makes it more
* user friendly and it is assumed as a high quality code.
*
*
* @author Zara Ali
* @version 1.0
* @since 2014-03-31
*/
public class HelloWorld {
public static void main(String[] args) {
// Prints Hello, World! on standard output.
System.out.println(“Hello World!”);
}
}
जावडॉक टैग (The javadoc Tags in Hindi)
Javadoc टूल निम्न टैग को पहचानता है –
| Tag | Description | Syntax |
| @author | class के लेखक को जोड़ता है। | @author name-text |
| {@code} | HTML मार्कअप या नेस्टेड जावाडॉक टैग के रूप में पाठ की व्याख्या किए बिना कोड फ़ॉन्ट में पाठ प्रदर्शित करता है। | {@code text} |
| {@docRoot} | किसी भी जेनरेट किए गए पेज से जेनरेट किए गए दस्तावेज़ की रूट निर्देशिका के सापेक्ष पथ का प्रतिनिधित्व करता है। | {@docRoot} |
| @deprecated | एक टिप्पणी जोड़ता है जो इंगित करता है कि इस एपीआई का अब उपयोग नहीं किया जाना चाहिए। | @deprecated deprecatedtext |
| @exception | जनरेट किए गए दस्तावेज़ में वर्ग नाम और विवरण टेक्स्ट के साथ थ्रो उपशीर्षक जोड़ता है। | @exception class-name description |
| {@inheritDoc} | निकटतम इनहेरिट करने योग्य वर्ग या कार्यान्वयन योग्य इंटरफ़ेस से एक टिप्पणी प्राप्त करता है. | Inherits a comment from the immediate surperclass. |
| {@link} | दृश्य पाठ लेबल के साथ एक इन-लाइन लिंक सम्मिलित करता है जो निर्दिष्ट पैकेज, वर्ग, या संदर्भित वर्ग के सदस्य नाम के लिए दस्तावेज़ीकरण की ओर इशारा करता है। | {@link package.class#member label} |
| {@linkplain} | {@link} के समान, सिवाय इसके कि लिंक का लेबल कोड फ़ॉन्ट की तुलना में सादे पाठ में प्रदर्शित होता है। | {@linkplain package.class#member label} |
| @param | “पैरामीटर” खंड में निर्दिष्ट विवरण के बाद निर्दिष्ट पैरामीटर-नाम के साथ एक पैरामीटर जोड़ता है। | @param parameter-name description |
| @return | विवरण पाठ के साथ “रिटर्न” अनुभाग जोड़ता है। | @return description |
| @see | लिंक या पाठ प्रविष्टि के साथ एक “यह भी देखें” शीर्षक जोड़ता है जो संदर्भ की ओर इशारा करता है। | @see reference |
| @serial | एक डिफ़ॉल्ट क्रमिक क्षेत्र के लिए दस्तावेज़ टिप्पणी में उपयोग किया जाता है। | @serial field-description | include | exclude |
| @serialData | writeObject( ) या writeExternal( ) विधियों द्वारा लिखे गए डेटा का दस्तावेजीकरण करें। | @serialData data-description |
| @serialField | एक ObjectStreamField घटक का दस्तावेजीकरण करता है। | @serialField field-name field-type field-description |
| @since | जनरेट किए गए दस्तावेज़ में निर्दिष्ट सिन्स-टेक्स्ट के साथ “Since” शीर्षक जोड़ता है। | @since release |
| @throws | @throws और @Exception टैग पर्यायवाची हैं। | @throws class-name description |
| {@value} | जब {@value} का उपयोग किसी स्थिर फ़ील्ड के दस्तावेज़ टिप्पणी में किया जाता है, तो यह उस स्थिरांक का मान प्रदर्शित करता है। | {@value package.class#field} |
| @version | जब -वर्जन विकल्प का उपयोग किया जाता है तो जनरेट किए गए डॉक्स में निर्दिष्ट संस्करण-पाठ के साथ एक “संस्करण” उपशीर्षक जोड़ता है। | @version version-text |
उदाहरण
निम्नलिखित कार्यक्रम प्रलेखन टिप्पणियों के लिए उपलब्ध कुछ महत्वपूर्ण टैगों का उपयोग करता है। आप अपनी आवश्यकताओं के आधार पर अन्य टैग का उपयोग कर सकते हैं।
AddNum वर्ग के बारे में प्रलेखन HTML फ़ाइल AddNum.html में तैयार किया जाएगा लेकिन साथ ही एक नाम index.html के साथ एक मास्टर फ़ाइल भी बनाई जाएगी।
import java.io.*;
/**
* <h1>Add Two Numbers!</h1>
* The AddNum program implements an application that
* simply adds two given integer numbers and Prints
* the output on the screen.
* <p>
* <b>Note:</b> Giving proper comments in your program makes it more
* user friendly and it is assumed as a high quality code.
*
* @author Zara Ali
* @version 1.0
* @since 2014-03-31
*/
public class AddNum {
/**
* This method is used to add two integers. This is
* a the simplest form of a class method, just to
* show the usage of various javadoc Tags.
* @param numA This is the first paramter to addNum method
* @param numB This is the second parameter to addNum method
* @return int This returns sum of numA and numB.
*/
public int addNum(int numA, int numB) {
return numA + numB;
}
/**
* This is the main method which makes use of addNum method.
* @param args Unused.
* @return Nothing.
* @exception IOException On input error.
* @see IOException
*/
public static void main(String args[]) throws IOException {
AddNum obj = new AddNum();
int sum = obj.addNum(10, 20);
System.out.println(“Sum of 10 and 20 is :” + sum);
}
}
अब, उपरोक्त AddNum.java फ़ाइल को javadoc यूटिलिटी का उपयोग करके निम्नानुसार प्रोसेस करें –
$ javadoc AddNum.java
Loading source file AddNum.java…
Constructing Javadoc information…
Standard Doclet version 1.7.0_51
Building tree for all the packages and classes…
Generating /AddNum.html…
AddNum.java:36: warning – @return tag cannot be used in method with void return type.
Generating /package-frame.html…
Generating /package-summary.html…
Generating /package-tree.html…
Generating /constant-values.html…
Building index for all the packages and classes…
Generating /overview-tree.html…
Generating /index-all.html…
Generating /deprecated-list.html…
Building index for all classes…
Generating /allclasses-frame.html…
Generating /allclasses-noframe.html…
Generating /index.html…
Generating /help-doc.html…
1 warning
$
हम उम्मीद करते है कि आपको “जावा डॉक्यूमेंटेशन कमैंट्स (Java Documentation Comments in Hindi)” से सम्बंधित जानकारी हिंदी में समझ में आयी होंगी यदि आपको बताई गई जानकारी अच्छी लगी हो तो अपने दोस्तों में ऐसे शेयर करे जिससे उनकी भी हेल्प हो सके धन्यवाद!