[Eclipse] CheckStyle ローカル・チェック構成

EclipseのプラグインCheckStyleについて、プロジェクトに対してのみ設定する方法調べた。

CheckStyleとは
 Javaコードが、コーディング規約にそって記述されているか、静的解析ツールです。

デフォルトであるCheckStyleの「Sun Checks(sun コーディング規約チェックの Checkstyle 構成です。)」を拡張してみた。

1. デフォルトの「Sun Checks」のエクスポート

Eclipseのツールバーの[ウィンドウ][設定] の左メニューの[Checkstyle]を選択します。
Checkstyleの画面にて、「Sun Checks」を選択し、[エクスポート]ボタンを押下します。
対象プロジェクト配下の適当な場所にエクスポートします。

2. ローカル構成の設定

プロジェクトを右クリックメニューの「プロパティ」を選択します。
右メニューのCheckstyleを選択します。
[ローカル・チェック構成]タブを選択し、[新規]ボタンを押下します。

各項目を入力し、OKを押します。
 型:「プロジェクト相対構成」を選びます。
 名前:名前をつけます。
 ロケーション:■1でエクスポートしたファイルを選択します。
 説明:説明を記載します。

一覧に反映されます。

メインタブにて、先ほど追加したCheckstyleを選択します。
「このプロジェクトでCheckstyleをアクティブにする」にチェックすると、静的解析ツールが実行されます。

ダイアログがでますが[はい]を選びます。

3. CheckStyke拡張メモ

CheckStyleの定義を変更方法です。
プロジェクトを右クリックメニューの「プロパティ」を選択します。
右メニューのCheckstyleを選択します。
[ローカル・チェック構成]タブにて、先ほど追加したCheckstyleを選択し、[構成]ボタンを押します。

ここでCheckstyleの構成を設定します。

<一部メモ>
1. Missing package-info.java file
 JavaDocコメント → パッケージJavaDoc

2. 名前 ”{0}” はパターン ”{1}” に一致しなければなりません。
 命名規約 → メンバー

3. 変数 ”{0}” は private とし、アクセッサメソッドを持つべきです。
 クラス設計 → 可視性修飾子

4. メソッド ”{0}” は拡張するように設計されていません – abstract か final か空である必要があります。
 クラス設計 → 拡張のための設計

5. 行が {0,number,integer} 文字を超えています。
 サイズ違反 → 行の最大長 80→150

6. ”{0}” がフィールドを隠しています。
 コーディング問題 → 隠しフィールド

以上でした。