マニュアル: Checkstyle

投稿日: 更新日: Java 静的コード解析

設定ファイル

書き方

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE module PUBLIC
  "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
  "https://checkstyle.org/dtds/configuration_1_3.dtd">

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

モジュールの種類

重要なモジュール

重大度(Severity)

Severity

<property name="severity" value="..." />として定義可能。 設定可能な値は以下の4つ。

メッセージのカスタマイズ

Custom Messages

<module>の子要素として、 <message key="..." value="..." />のように定義する。

keyとvalueに設定する値は、 各モジュールの説明に "Error Messages" というのがあるので、 そのリンク先から取得できる。

モジュール

TreeWalker

TreeWalker

ファイルを辿っていくモジュールです。 多くのモジュールの親として使われます。

チェック

モジュール名 親モジュール チェック内容 カスタマイズ
ExplicitInitialization TreeWalker インスタンス変数がデフォルト値で初期化されていないかのチェック 対象をオブジェクトのみにするかどうか
FileLength Checker ファイルの行数チェック 許容する行数、対象ファイル名
TodoComment TreeWalker TODOコメントがないかのチェック 拾うコメント形式

ページトップへ戻る