जावाडोक: दस्तावेज़ों में नोट्स/टिप्पणियां कहां जोड़ना है?

Question

सी # में कोडिंग करते समय मुझे हमेशा टैग remarks टैग या विधि के कार्यान्वयन के बारे में नोट्स प्रदान करने के लिए बहुत उपयोगी लगता है, या जो मैं लागू कर रहा था उसके सिद्धांत के बारे में जानकारी देने के लिए। अब मैं जावा का उपयोग कर रहा हूं लेकिन मुझे इसके लिए एक उचित जावाडॉक टैग नहीं मिल रहा है। शायद जावा में आप इसे एक अलग तरीके से पूरा करते हैं, क्या किसी को पता है?

Answer 1

जहाँ तक मुझे पता है, वहाँ isn ' नोट्स या टिप्पणियों के लिए कोई समर्पित जावाडोक टैग नहीं। आम तौर पर, जावाडोक की पहली वाक्य कक्षा/विधि/क्षेत्र का संक्षिप्त विवरण देना चाहिए। फिर पूरा विवरण का पालन करना चाहिए। और यदि आप किसी भी नोट्स को शामिल करना चाहते हैं, तो "नोट:" के साथ एक विशेष पैराग्राफ पर्याप्त होना चाहिए।

/** 
* Brief description. Full description of the method, generally without 
* implementation details. 
* <p> 
* Note: Additional information, e.g. your implementation notes or remarks. 
* </p> 
* @param input description of the parameter 
* @return description of return value 
* 
* @since version 
* @author name of the author 
*/ 
public boolean doSomething(String input) 
{ 
    // your code 
} 

Answer 2

आपको लगता है कार्यान्वयन विवरण पर्याप्त दिलचस्प जावाडोक का एक हिस्सा बनने के लिए कर रहे हैं, तो आप बस जावाडोक टिप्पणी अपने आप में एक पैराग्राफ में उन्हें प्रदान करना चाहिए:

/** 
* Does something. 
* <p> 
* <b>Implementation details:</b><br /> 
* Blah blah blah... 
* </p> 
*/ 
public void doSomething() { 
    // ... 
} 

Answer 3

आप अपने स्वयं के कस्टम टैग भी बना सकते हैं।

जावाडोक -tag टिप्पणी:

/** 
    * Quark represents a quark. 
    * 
    * @note If you spin a quark, it will spin forever! 
    */ 
    public class Quark { 

    } 

इस तरह से ऊपर, चलाने जावाडोक के लिए javadocs बनाने के लिए:

यहाँ एक जावाडोक टिप्पणी है कि कस्टम टैग "@note" भी शामिल है एक : "ध्यान दें:" Quark.java

स्रोत: http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.htm

Answer 4

जावा प्रोग्रामिंग भाषा के पुनरावृत्ति 8 के साथ, अंततः डेवलपर्स को उनके अतिरिक्त दस्तावेज – में उपयोग किए जा सकते हैं और आपकी आवश्यकताओं को पूरा करना चाहिए: @apiNote, @implSpec और @implNote (उदाहरण के लिए, अधिक विस्तृत जानकारी के लिए चर्चा: blog.codefx.org/java/new-javadoc-tags/)।