Checkstyle Javaルール

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

EmptyForInitializerPad

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.4 for文の空の初期化式に空白を許可するかどうかをチェックする。 forの初期化式後に改行されている場合はチェッ…

TypeName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 型名が指定の正規表現にマッチしているがどうかをチェックする。 プロパティ プロパティ 型 デフォルト値 説明 …

StaticVariableName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 staticでfinalでない変数の変数名が指定の正規表現にマッチしているがどうかをチェックする。 プロパティ プロ…

RecordTypeParameterName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.36 プロパティ プロパティ 型 デフォルト値 説明 追加バージョン format Pattern "^[A-Z]$" レコードの型パラメー…

RecordComponentName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.40 レコードコンポーネント名が指定の正規表現にマッチしているがどうかをチェックする。 プロパティ プロパティ …

PatternVariableName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.36 パターン変数名が指定の正規表現にマッチしているがどうかをチェックする。 プロパティ プロパティ 型 デフォ…

ParameterName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 メソッドのパラメータ名が指定の正規表現にマッチしているがどうかをチェックする。 accessModifiersプロパティ…

PackageName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 パッケージ名が指定の正規表現にマッチしているがどうかをチェックする。 formatのデフォルト値は、Java言語仕…

MethodTypeParameterName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.0 メソッドの型パラメータ名が指定の正規表現にマッチしているがどうかをチェックする。 プロパティ プロパティ …

MethodName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 メソッド名が指定の正規表現にマッチしているがどうかをチェックする。 クラス名と同じ名前のメソッドが存在す…

MemberName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 インスタンス変数名が指定の正規表現にマッチしているがどうかをチェックする。 プロパティ プロパティ 型 デフ…

LocalVariableName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 finalでないローカル変数名が指定の正規表現にマッチしているがどうかをチェックする。 catchパラメータはロー…

LocalFinalVariableName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 finalなローカル変数名が指定の正規表現にマッチしているがどうかをチェックする。 catchパラメータとtry文のリ…

LambdaParameterName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.11 ラムダ式のパラメーター名が指定の正規表現にマッチしているがどうかをチェックする。 プロパティ プロパティ …

InterfaceTypeParameterName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.8 インターフェイス型のパラメータ名が、指定された正規表現に適合しているかどうかをチェックする。 プロパティ …

IllegalIdentifierName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.36 制限された名前や文脈上のキーワードなど、不正な名前の集合のパターンを持つ識別子をチェックする。 例として…

ConstantName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 定数名が指定された正規表現に適合しているかどうかをチェックする。 定数とは、serialVersionUIDとserialPersi…

ClassTypeParameterName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.0 クラスの型パラメーターの名前が、指定された正規表現に合致しているかどうかをチェックする。 プロパティ プロ…

CatchParameterName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 6.14 catch句のパラメータ名が指定された正規表現にマッチしているかどうかをチェックする。 デフォルトの正規表現…

AbstractClassName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 抽象クラスのクラス名が定義した正規表現にマッチしていることをチェックする。 併せてabstract修飾子が存在す…

AbbreviationAsWordInName

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.8.0 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.8 識別子名に含まれる略語(連続した大文字)の長さを検証する。 キャメルケースの命名を強制することも可能であ…

RecordComponentNumber

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.36 レコード定義のヘッダに含まれるレコードコンポーネントの数をチェックする。 プロパティ プロパティ 型 デフ…

ParameterNumber

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

OuterTypeNumber

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.0 1ファイルに宣言されるルートクラスの数をチェックする。 プロパティ プロパティ 型 デフォルト値 説明 追加バ…

MethodLength

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 行数の多いメソッドとコンストラクタがないかチェックする。 メソッドが非常に長くなると理解するのが難しくな…

MethodCount

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.3 各クラスやインターフェースで宣言されているメソッドの数を、アクセス修飾子ごともしくは総数でチェックする。…

LineLength

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.0 長すぎる1行の記述がないかチェックする。 デフォルトではパッケージとインポートの記述はチェック対象外。 プ…

LambdaBodyLength

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 8.37 ラムダ式の行数が指定の値よりも多くないかチェックする。 匿名内部クラスと同様に、ラムダ本体が非常に長くな…

FileLength

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 5.0 長いソースファイルがないかチェックする。 ソースファイルが非常に長くなると、理解するのが難しくなるため、…

ExecutableStatementCount

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 チェック概要 チェック追加バージョン Checkstyle 3.2 実行可能なステートメントの数が指定した値を超えていないかチェックする。 プロパティ プロパティ 型 デフォル…