SingleLineJavadoc

CheckStyle公式ドキュメント

検証環境

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

---

チェック概要

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

Javadocブロックが1行に収まるかどうか、ブロックタグを含まないかどうかをチェックする。
少なくとも1つのブロックタグを含むJavadocコメントは、数行でフォーマットされる必要がある。

プロパティ

プロパティ	型	デフォルト値	説明	追加バージョン
violateExecution OnNonTightHtml	boolean	false	JavadocがTight-HTMLルールに違反している場合、違反を表示するタイミングを制御するかどうか	8.3
ignoredTags	String[]	{}	チェック対象外とするブロックタグを指定	6.8
ignoreInlineTags	boolean	true	インラインタグを無視するかどうか	6.8

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

// NG ブロックタグを含む場合、Javadocは複数行である必要がある
/** @see Math */
public int foo() {
  return 42;
}

// OK
/**
 * @return 42
 */
public int bar() {
  return 42;
}

// OK
/** {@link #equals(Object)} */
public int baz() {
  return 42;
}

プロパティ設定あり

ignoredTags

チェック対象外とするブロックタグを指定する。

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="SingleLineJavadoc">
            <property name="ignoredTags" value="@inheritDoc, @see"/>
        </module>
    </module>
</module>

チェック実行例

// OK @seeはチェック対象外
/** @see Math */
public int foo() {
  return 42;
}

// OK
/**
 * @return 42
 */
public int bar() {
  return 42;
}

ignoreInlineTags

インラインタグを無視するかどうか（デフォルト：true）

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="SingleLineJavadoc">
            <property name="ignoreInlineTags" value="false"/>
        </module>
    </module>
</module>

チェック実行例

// OK
/**
 * @return 42
 */
public int bar() {
  return 42;
}

// NG Javadocは複数行である必要がある
/** {@link #equals(Object)} */
public int baz() {
  return 42;
}