JavadocParagraph

CheckStyle公式ドキュメント

検証環境

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

---

チェック概要

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

Javadocの段落をチェックする。

以下のチェックが行われる。

• 2つの段落の間にそれぞれ1行の空白行がある
• 最初の段落以外の各段落は、最初の単語の直前に<p>があり、その後に空白がない

プロパティ

プロパティ	型	デフォルト値	説明	追加バージョン
violateExecutionOnNonTightHtml	boolean	false	JavadocがTight-HTMLルールに違反している場合、違反を表示するタイミングを制御するかどうか	8.3
allowNewlineParagraph	boolean	true	<p>タグを最初の単語の直前に置くかどうか	6.9

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

/**
 * コメント！
 *
 * <p>pタグの後ろにすぐコメントを記述する
 * <p>pタグの前には1行の空行が必要（NG）
 *
 * <p>
 * pタグの後で改行しない（NG）
 *
 * <p> pタグの後ろにスペースを挿入しない（NG）
 *
 */
public class MyClass {
}

プロパティ設定あり

allowNewlineParagraph

<p>タグを最初の単語の直前に置くかどうか（デフォルト：true）

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="JavadocParagraph">
            <property name="allowNewlineParagraph" value="false"/>
        </module>
    </module>
</module>

チェック実行例

/**
 * コメント！
 *
 * <p>pタグの後ろにすぐコメントを記述する
 * <p>pタグの前には1行の空行が必要（NG）
 *
 * <p>
 * pタグの後で改行してもよい
 *
 * <p> pタグの後ろにスペースを挿入してもよい
 *
 */
public class MyClass {
}