कोडस्टाइल; एनोटेशन से पहले या बाद में जावाडोक डालें?

Question

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

/** 
* This is a javadoc comment before the annotation 
*/ 
@Component 
public class MyClass { 

    @Autowired 
    /** 
    * This is a javadoc comment after the annotation 
    */ 
    private MyOtherClass other; 
} 

Answer 1

एनोटेशन से पहले, एनोटेशन कोड है जो कक्षा से "संबंधित" है। आधिकारिक दस्तावेज़ीकरण में examples with javadoc देखें।

/** 
* Delete multiple items from the list. 
* 
* @deprecated Not for public use. 
* This method is expected to be retained only as a package 
* private method. Replaced by 
* {@link #remove(int)} and {@link #removeAll()} 
*/ 
@Deprecated public synchronized void delItems(int start, int end) { 
    ... 
} 

Answer 2

यह सब readablity करने के लिए नीचे आता है:

यहाँ यादृच्छिक उदाहरण मैं another official Java page में पाया है। मेरी राय कोड में विधि/फ़ील्ड के ऊपर सीधे एनोटेशन के साथ अधिक पठनीय है।

Answer 3

मैं पहले से दिए गए उत्तरों से सहमत हूं।

एनोटेशन कोड जबकि जावाडोक प्रलेखन (इसलिए नाम) का हिस्सा है का हिस्सा हैं।

तो मेरे लिए यह कोड भागों को एक साथ रखने के लिए उचित है।

Answer 4

कोडिंग मानक के अलावा, ऐसा लगता है कि जावाडॉक टिप्पणियां जावा डॉक टिप्पणियों को संसाधित नहीं करती हैं अगर उन्हें एनोटेशन के बाद रखा जाता है। अन्यथा ठीक काम करता है।