JavadocMissingWhitespaceAfterAsterisk

CheckStyle公式ドキュメント

検証環境

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

---

チェック概要

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

先頭のアスタリスクの後に少なくとも1つの空白があるかどうかをチェックする。
アスタリスクの後の空白はJavadocのコメントでは任意ですが、空白がないと文書が読みにくくなる。
先頭のアスタリスクの後に少なくとも1つの空白を入れるのがデファクトスタンダードとなっている。

プロパティ

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

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

// NG アスタリスクの後ろに空白がない
/**
*コメント
*/
int invalidJavaDoc;

プロパティ設定あり

設定ファイル記述方法

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