जावा - एक विधि एनोटेशन के साथ जावाडोक का उपयोग करने के लिए सम्मेलन?

Question

मैं निम्न विधि है:

@Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

मैं इस विधि के लिए एक जावाडोक जोड़ना चाहते हैं, वहाँ कैसे @Override एनोटेशन (या किसी अन्य एनोटेशन) होने के साथ-साथ यह करने के लिए पर कोई सम्मेलन है?

कारण मैं पूछता हूं क्योंकि मैंने पढ़ा है कि javadoc टिप्पणियां विधि से पहले सीधे होनी चाहिए (दोनों के बीच कोई नई लाइन नहीं), और मुझे यकीन नहीं है कि अगर @ ओवरराइड एनोटेशन से ऊपर जावाडोक टिप्पणी सीधे डाली जाए तो चीज़ें ऊपर ले जाएं।

क्या यह उदाहरण के लिए ऐसा करने का पारंपरिक तरीका होगा? क्या यह काम करता है?

/** 
    * This is my method's javadoc comment. 
    */ 
    @Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

Answer 1

हां, यह तरीका सही तरीका है, मैंने अभी तक दूसरी तरफ नहीं देखा। और हाँ, इस तरह यह काम करता है। दूसरी तरफ कोशिश नहीं की।

/** 
    * This is my method's javadoc comment. 
    */ 
    @Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

लेकिन मूल रूप से मैं आमतौर पर एक जावाडोक टिप्पणी एक विधि है कि एक और तरीका ओवरराइड करता है, जब इंटरफेस को लागू नहीं जोड़ेगा विशेष रूप से। बड़े प्रयासों के बिना दस्तावेज वितरित करने के लिए टैग @inheritDoc यहां सहायक है। लेकिन यह इस उदाहरण के लिए विशिष्ट है, आप भी अन्य एनोटेशन जोड़ सकते हैं।

Answer 2

हां, यह सही तरीके से काम करेगा। उदाहरण के लिए, ओपनजेडके से source code of java.lang.String में, वे @Deprecated एनोटेशन के शीर्ष पर जावाडोक का उपयोग कर रहे हैं।