Checkstyle Javaルール

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

Javadoc Comments

WriteTag

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 4.2 ユーザー定義のJavadocタグが、定義されたフォーマットで Javadoc コメントに存在することをチェックする。 タ…

SummaryJavadoc

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 Javadocの要約文に、使用を推奨しない語句が含まれていないかチェックする。 {@inheritDoc}タグのみを含む場合、チェックはスキップされ、空でない{@cod…

SingleLineJavadoc

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 6.0 Javadocブロックが1行に収まるかどうか、ブロックタグを含まないかどうかをチェックする。 少なくとも1つのブロ…

RequireEmptyLineBeforeBlockTagGroup

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.36 Javadocにブロックタグがある場合、その前に1行の空行があるかどうかをチェックする。 プロパティ プロパティ …

NonEmptyAtclauseDescription

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 6.0 ブロックタグの後に記述があるかどうかをチェックする。 プロパティ プロパティ 型 デフォルト値 説明 追加バー…

MissingJavadocType

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.20 クラス、enum、インターフェース、およびアノテーション・インターフェース定義の Javadocコメントが欠落して…

MissingJavadocPackage

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.22 package-info.javaファイルにJavadocコメントがないかどうかをチェックする。 設定+チェック実行結果 プロパ…

MissingJavadocMethod

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.21 メソッドまたはコンストラクタのJavadocコメントが欠落していないかどうかをチェックする。 検証するスコープ…

JavadocVariable

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 変数がJavadocコメントを持つかどうかをチェックする。 serialVersionUIDフィールドは無視される。 プロパティ …

JavadocType

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 型定義のJavadocコメントをチェックする。 デフォルトでは、authorやversionのタグはチェックしない。 検証する…

JavadocTagContinuationIndentation

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 6.0 ブロックタグの継続行のインデントをチェックする。 継続行とは、タグのある行を越えて記述が続くことを指す。 …

JavadocStyle

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 Javadocコメントが適切に形成されていることを確認するために、コメントをチェックする。 以下のチェックを行う…

JavadocParagraph

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 6.0 Javadocの段落をチェックする。 以下のチェックが行われる。 2つの段落の間にそれぞれ1行の空白行がある 最初の…

JavadocPackage

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.0 各Javaパッケージがコメント用に使用されるJavadocファイルを持っているかどうかをチェックする。 デフォルトで…

JavadocMissingWhitespaceAfterAsterisk

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.32 先頭のアスタリスクの後に少なくとも1つの空白があるかどうかをチェックする。 アスタリスクの後の空白はJavad…

JavadocMissingLeadingAsterisk

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.38 Javadocが各行の先頭にアスタリスクを持つかどうかをチェックする。 このチェックでは、最後の行が空白である…

JavadocMethod

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 メソッドまたはコンストラクタの Javadoc をチェックする。 paramタグが存在しないパラメータの検出はallowMiss…

JavadocContentLocation

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.27 プロジェクト内のすべての Javadoc コメントで、Javadocコンテンツが同じ位置から始まるかどうかをチェックす…

JavadocBlockTagLocation

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.24 Javadocのブロックタグが行頭にのみ現れるかどうかをチェックする。 ブロックタグは、@記号で始まり、空白が前…

InvalidJavadocPosition

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.23 Javadoc が正しい位置に配置されているかどうかをチェックする。 Documentation Comment Specification for th…

AtclauseOrder

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 6.0 JavadocブロックタグまたはJavadocタグの順序をチェックする。 プロパティ プロパティ 型 デフォルト値 説明 追…