198

これが最も重要な問題ではないことは知っていますが、注釈の前または後にjavadocコメントブロックを配置できることに気づきました。コーディング標準として何を採用したいですか？

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

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

5 に答える 5

212

アノテーションの前は、アノテーションはクラスに「属する」コードであるためです。公式ドキュメントのjavadocの例を参照してください。

別の公式Javaページで見つけたランダムな例を次に示します。

/**
 * 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) {
    ...
}
于 2010-06-24T12:37:00.373 に答える
18

私はすでに与えられた答えに同意します。

注釈はコードの一部ですが、javadocはドキュメントの一部です（そのため名前が付けられています）。

したがって、私にとっては、コード部分を一緒に保つことは合理的です。

于 2010-06-24T13:05:01.240 に答える
14

コーディング標準は別として、javadocツールは、注釈の後に配置されている場合、javadocコメントを処理しないようです。それ以外の場合は正常に動作します。

于 2013-10-25T08:49:37.563 に答える
13

それはすべて読みやすさに帰着します。私の意見では、コードはメソッド/フィールドのすぐ上にあるアノテーションを使用すると読みやすくなります。

于 2010-06-24T12:38:22.393 に答える
0

上記のすべてに同意します。RestEasyスタイルを使用すると、IntelliJ（Idea）のコードスタイルテンプレートが偽陽性（@throwsが正しく指定されている場合は警告）と偽陰性（@throwsが指定されていないが、指定されている必要がある場合）の両方で失敗することが他の人に役立つ場合があります注釈。私はjavadocを他の何よりも優先し、次にアノテーション、そしてコードを配置します。

こちらのバグレポートをご覧ください： https ：//youtrack.jetbrains.com/issue/IDEA-220520

于 2019-08-12T17:38:55.990 に答える