Checkstyle Javaルール

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

OuterTypeNumber

CheckStyle公式ドキュメント

検証環境

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


チェック概要

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

1ファイルに宣言されるルートクラスの数をチェックする。

プロパティ

プロパティ デフォルト値 説明 追加バージョン
max int 1 最大値 5.0

設定+チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

デフォルトでは1ファイルに複数クラス宣言されているとNG

プロパティ設定あり

max

1ファイルの最大クラス数(デフォルト:1)

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="OuterTypeNumber">
            <property name="max" value="2"/>
        </module>
    </module>
</module>

チェック実行例

デフォルトでは1ファイルに3クラス以上宣言されているとNG