RequireEmptyLineBeforeBlockTagGroup

CheckStyle公式ドキュメント

検証環境

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

---

チェック概要

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

Javadocにブロックタグがある場合、その前に1行の空行があるかどうかをチェックする。

プロパティ

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

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

/**
 * コメント
 * @return something (NG：上に1行空行が必要)
 */
public boolean foo() {
    return false;
}