UnusedImports

CheckStyle公式ドキュメント

検証環境

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

---

チェック概要

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

未使用の import 文をチェックする。
import 文は、以下の場合に未使用とみなされる。

• ファイル内で参照されることはない場合
• 他のインポートと重複している場合
• java.langパッケージのインポート
• 同じパッケージからのインポート
• Javadocコメントで参照されている
  import java.util.List は、Javadoc コメント {@link List} で参照されているとみなされる

プロパティ

プロパティ	型	デフォルト値	説明	追加バージョン
processJavadoc	boolean	true	Javadocコメントを処理するかどうか	5.4

設定＋チェック実行結果

プロパティ設定なし

設定ファイル記述方法

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

チェック実行例

package Test;

// NG この記述は不要
import java.lang.String;
// NG この記述は不要
import java.util.List;


public class MyClass{
    
    /**
    * {@link List}
    */
    public void foo(){
        String s = "aaa";
    }
};

プロパティ設定あり

processJavadoc

Javadocコメントを処理するかどうか（デフォルト：true）

設定ファイル記述方法

<module name="Checker">
    <module name="TreeWalker">
        <module name="UnusedImports">
            <property name="processJavadoc" value="false"/>
        </module>
    </module>
</module>

チェック実行例

package Test;

// NG
import java.lang.String;
// OK Javadocで使用されているものはチェック対象外とする
import java.util.List;


public class MyClass{
    
    /**
    * {@link List}
    */
    public void foo(){
        String s = "aaa";
    }
};