FileLength

CheckStyle公式ドキュメント

検証環境

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

---

チェック概要

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

長いソースファイルがないかチェックする。

ソースファイルが非常に長くなると、理解するのが難しくなるため、長いクラスは通常、特定のタスクに焦点を当てたいくつかの個別のクラスにリファクタリングする必要がある。

プロパティ

プロパティ	型	デフォルト値	説明	追加バージョン
max	int	2000	最大値	3.2
fileExtensions	String[]	all files	チェック対象のファイルの拡張子	5.0

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

<module name="Checker">
    <module name="FileLength"/>
</module>

プロパティ設定あり

max

ファイルの行数の最大値。デフォルト：2000

設定ファイル記述方法

<module name="Checker">
    <module name="FileLength">
        <property name="max" value="3"/>
    </module>
</module>

チェック実行例

// maxに指定した値よりもソースファイルの行数が長い場合NGとなる
package jp.co.sample;

public class MyClass {
    
}

fileExtensions

チェック対象のファイルの拡張子

設定ファイル記述方法

<module name="Checker">
    <module name="FileLength">
        <property name="fileExtensions" value="xml"/>
    </module>
</module>

チェック実行例

// javaファイルはチェック対象外
package jp.co.sample;

public class MyClass {
    
}