JavadocTagContinuationIndentation

CheckStyle公式ドキュメント

検証環境

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

---

チェック概要

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

ブロックタグの継続行のインデントをチェックする。
継続行とは、タグのある行を越えて記述が続くことを指す。
デフォルトのインデントは最低4だが、プロパティで変更することが可能。

プロパティ

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

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

/**
 * @tag comment
 *  Indentation spacing is 1. （NG：インデントが足りてない）
 *   Indentation spacing is 2. （NG：インデントが足りてない）
 *     Indentation spacing is 4.
 */
public class MyClass {
}

プロパティ設定あり

offset

新しいインデントレベルに使用するスペース数

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="JavadocTagContinuationIndentation">
            <property name="offset" value="2"/>
        </module>
    </module>
</module>

チェック実行例

/**
 * @tag comment
 * Indentation spacing is 0. （NG：インデントが足りてない）
 *   Indentation spacing is 2.
 *     Indentation spacing is 4. （NG：インデントが多い）
 */
public class MyClass {
}