Checkstyle Javaルール

CheckstyleのJavaルールについて1つずつまとめます

トップ > Javadoc Comments > NonEmptyAtclauseDescription

NonEmptyAtclauseDescription

Javadoc Comments

CheckStyle公式ドキュメント

検証環境

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

チェック概要

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

ブロックタグの後に記述があるかどうかをチェックする。

プロパティ

プロパティ 型 デフォルト値 説明 追加バージョン
violateExecution OnNonTightHtml boolean false JavadocがTight-HTMLルールに違反している場合、違反を表示するタイミングを制御するかどうか 8.3
javadocTokens Javadocトークンの サブセット PARAM_LITERAL,
RETURN_LITERAL,
THROWS_LITERAL,
EXCEPTION_LITERAL,
DEPRECATED_LITERAL		 チェック対象のJavadocトークン 7.3

〇 Javadocトークンのサブセットには以下の値が設定可能

値 説明
PARAM_LITERAL param
RETURN_LITERAL return
THROWS_LITERAL throws
EXCEPTION_LITERAL exception
DEPRECATED_LITERAL deprecated

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

/**
* コメント
*
* @param a Some javadoc
* @param b // NG 説明がない
* @deprecated // NG 説明がない
* @throws Exception // NG 説明がない
*/
public int method(String a, int b) throws Exception {
    return 1;
}

プロパティ設定あり

javadocTokens

チェック対象のJavadocトークンを指定する

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="NonEmptyAtclauseDescription">
            <property name="javadocTokens" value="PARAM_LITERAL,RETURN_LITERAL"/>
        </module>
    </module>
</module>

チェック実行例

/**
* コメント
*
* @param a Some javadoc
* @param b // NG 説明がない
* @deprecated
* @throws Exception
*/
public int method(String a, int b) throws Exception {
    return 1;
}