Checkstyle Javaルール

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

2022-01-01から1年間の記事一覧

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タグの順序をチェックする。 プロパティ プロパティ 型 デフォルト値 説明 追…

FinalLocalVariable

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 値が変更されることのないローカル変数がfinalで宣言されているかどうかをチェックする。 変更されないパラメータがfinalと宣言されているかどうかもチ…

FallThrough

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 switch の case にコードが含まれているが、break、return、throw、continue文がない箇所がないかどうかをチェックする。 チェックは、警告を抑制するた…

ExplicitInitialization

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 クラスまたはオブジェクトのメンバが明示的にその型のデフォルト値に初期化されているかどうかをチェックする。…

EqualsHashCode

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 equals()またはhashCode()をオーバーライドするクラスが、もう一方もオーバーライドされていることをチェックす…

EqualsAvoidNull

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.0 Stringのequals()メソッド呼び出し時にnullでない値が呼び元となっていることをチェックする。 あるフィールド…

EmptyStatement

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.1 空のステートメント(単体のセミコロン「;」)を検出する。 設定+チェック実行結果 設定ファイル記述方法 <module name="Checker"> <module name="TreeWalker"> <module name="EmptyStatement"/> </module> </module></module>…

DefaultComesLast

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.4 switch文の中で default がすべてのcaseの後にあることをチェックする。 Javaではswitch文の中のどこでもdefaul…

DeclarationOrder

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 クラス、レコード、インタフェース宣言の各部分が、Javaプログラミング言語のコード規約で推奨される順序で表示…

CovariantEquals

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 共変なequals()メソッドを定義しているクラスやレコードが、equals(Object)メソッドもオーバーライドしているか…

AvoidNoArgumentSuperConstructorCall

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.29 引数なしのスーパークラスのコンストラクタ呼出しがあるかどうかをチェックする。 コンストラクタ本体は暗黙の…

AvoidInlineConditionals

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.1 インライン条件文を検出する。 〇 インライン条件文のサンプル String a = getParameter("a"); String b = (a =…