Checkstyle Javaルール

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

ArrayTrailingComma

CheckStyle公式ドキュメント

検証環境

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


チェック概要

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

配列の初期化時に、末尾にコンマが含まれているかどうかをチェックする。
デフォルトでは、配列の最後の要素と同じ行に左中括弧も右中括弧もない場合、最後にコンマが必要となる。

プロパティ

プロパティ デフォルト値 説明 追加バージョン
alwaysDemandTrailingComma boolean false 常に末尾のコンマをチェックするかどうか 8.33

設定+チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

// OK
int[] numbers = { 1, 2, 3 };

// NG 末尾にコンマが必要
boolean[] bools = {
    true,
    true,
    false
};

プロパティ設定あり

alwaysDemandTrailingComma

trueを設定した場合、配列の末尾に常にコンマが必要となる(デフォルト:false)

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="ArrayTrailingComma">
            <property name="alwaysDemandTrailingComma" value="true"/>
        </module>
    </module>
</module>

チェック実行例

// NG 「alwaysDemandTrailingComma=true」なので末尾にコンマが必要
int[] numbers = { 1, 2, 3 };

// NG 末尾にコンマが必要
boolean[] bools = {
    true,
    true,
    false
};