JavadocMissingLeadingAsterisk

CheckStyle公式ドキュメント

検証環境

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

---

チェック概要

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

Javadocが各行の先頭にアスタリスクを持つかどうかをチェックする。
このチェックでは、最後の行が空白である必要はないがJavadocの他のすべての行は、空白行とコードブロックを含めて、*で始まるべき。

プロパティ

プロパティ	型	デフォルト値	説明	追加バージョン
violateExecutionOnNonTightHtml	boolean	false	JavadocがTight-HTMLルールに違反している場合、違反を表示するタイミングを制御するかどうか	8.38

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

// NG 行頭にアスタリスクがない
/** あいう
    えお */ 
class MyClass {}

プロパティ設定あり

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="JavadocMissingLeadingAsterisk">
            <property name="violateExecutionOnNonTightHtml" value="true"/>
        </module>
    </module>
</module>