web-dev-qa-db-ja.com

コードスタイル;アノテーションの前後にjavadocを配置しますか？

私はそれが最も重要な問題ではないことを知っていますが、注釈の前後に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;
}
javacoding-styleannotationsjavadoccode-documentation
173
Paul McKenzie

注釈はクラスに「属する」コードであるため、注釈の前。公式ドキュメントの 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) {
    ...
}
185
Peter Jaric

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

注釈はcodeの一部ですが、javadocはdocumentationの一部です（そのため名前です）。

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

16
perdian

コーディング標準とは別に、javadocツールは、注釈の後に配置された場合、Java docコメントを処理しません。それ以外の場合は正常に動作します。

11
shadrik

それはすべて読みやすさにかかっています。私の意見では、コードはメソッド/フィールドのすぐ上のアノテーションで読みやすくなっています。

10
Robby Pond

上記のすべてに同意します。 IntelliJ（Idea）のコードスタイルテンプレートが、RestEasyスタイルを使用しているときに、誤って肯定的（@throwsが正しく指定されている場合、警告する）と誤って否定的（@throwsが指定されていないが、そうあるべき場合）の両方に失敗することは、他の人にとって役立つ場合があります注釈。私は自分のjavadocsを他のすべての上に配置し、次に注釈、そしてコードを配置します。

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

0
Max P Magee