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




coding-style annotations (3)

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

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

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

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

यहां एक यादृच्छिक उदाहरण है जो मैंने किसी अन्य आधिकारिक जावा पेज में पाया है:

/**
 * 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) {
    ...
}

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


यह सब पढ़ने योग्यता के लिए नीचे आता है। मेरी राय कोड में विधि / फ़ील्ड के ऊपर सीधे एनोटेशन के साथ अधिक पठनीय है।





code-documentation