JavadocContentLocation

CheckStyle公式ドキュメント

検証環境

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

---

チェック概要

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

プロジェクト内のすべての Javadoc コメントで、Javadocコンテンツが同じ位置から始まるかどうかをチェックする。
先頭のアスタリスクやスペースは、コンテンツの開始位置としてカウントされないため、無視される。

プロパティ

プロパティ	型	デフォルト値	説明	追加バージョン
location	JavadocContentLocationOption	second_line	Javadocコンテンツの配置に関するポリシーを指定	8.27

JavadocContentLocationOption

値	説明
FIRST_LINE	Javadocのコンテンツが/**と同じ行から始まる場合のポリシー
SECOND_LINE	Javadocのコンテンツが/**の次の行から始まる場合のポリシー

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

/** 最初の行からコメントを
  * 書いているのでNG
  */
/**
  * 2行目からコメントを書いているのでOK
  */
/** 1行コメントは対象外 */

プロパティ設定あり

location

Javadocコンテンツの配置に関するポリシー

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="JavadocContentLocationCheck">
            <property name="location" value="first_line"/>
        </module>
    </module>
</module>

チェック実行例

/** 最初の行からコメントを
   * 書いているのでOK
   */
/**
  * 2行目からコメントを書いているのでNG
  */
/** 1行コメントは対象外 */