InvalidJavadocPosition

CheckStyle公式ドキュメント

検証環境

Checkstyleバージョン：10.3.3
Javaバージョン：17

---

チェック概要

チェック追加バージョン
Checkstyle 8.23

Javadoc が正しい位置に配置されているかどうかをチェックする。
Documentation Comment Specification for the Standard Doclet で指定されているように、Javadoc はモジュール、パッケージ、クラス、インタフェース、コンストラクタ、メソッド、またはフィールド宣言の直前に置かれた場合のみ、正しく認識される。
メソッドの内部などそれ以外の位置では、このチェックでは無効と見なされる。

設定＋チェック実行結果

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="InvalidJavadocPosition"/>
    </module>
</module>

チェック実行例

// NG Javadocコメントはアノテーションの上に記述する
@SuppressWarnings("serial")
/**
 * This comment looks like javadoc but it at an invalid location.
 * Therefore, the text will not get into TestClass.html and the check will produce a violation.
 */
public class TestClass {
}