java - JavaDoc はメソッド レベルのアノテーションの前または後に配置する必要がありますか?

Question

アノテーション付きのメソッドに JavaDoc を配置するのに推奨される場所は? 注釈の前後？

@Test
/**
 * My doc
 */
public void testMyTest(){

}

また

/**
 * My doc
 */
@Test
public void testMyTest(){

}

Answer 1

それは問題ではないと思いますが、2 番目の形式の方が優れています。annotationsコードの一部であり、使用パターンごとに重要な役割を果たします。すべてのコード関連のエントリを一緒に保持することをお勧めします。

Answer 2

Javadoc コメントの後に注釈を付けるのが通常のスタイルのようです。

その理由は、注釈がドキュメントではなくコードの一部であるためです。

@Overrideこれはとには明らかではないかもしれません@Test。もちろん、注釈に関連するドキュメントもあります。しかし技術的には、注釈は特定の構文のJava コードです。