1. ホーム
  2. java

[解決済み] [Solved] codestyle; put javadoc before or after annotation?

2022-04-13 12:29:41

質問

最も重要な問題ではないことは分かっていますが、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;
}

解決方法は?

アノテーションの前に、アノテーションはクラスに "属する"コードであるため、アノテーションの前に。 参照 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) {
    ...
}