CheckStyleのインストールから設定まで(コーディング規約を設定できるEclipseプラグイン)

ドキュメントでコーディング規約を決めたとしても守らない人が多いのが現状です。
そんなときは指定したコーディング規約をEclipseでチェックできるCheckstyleプラグインが有効です。
EclipseでチェックできるCheckStyleプラグインについて説明します。

現在、CheckStyleの最新(2006/08現在)である「com.atlassw.tools.eclipse.checkstyle_4.1.0-bin.zip」
をダウンロードします。まずはCheckStyleのダウンロードサイトにアクセスします。

上記、赤丸部分(緑の部分)をクリック、次画面で「v4.1.0」のDownloadをクリックし
「com.atlassw.tools.eclipse.checkstyle_4.1.0-bin.zip」をダウンロードします。

ダウンロードした「com.atlassw.tools.eclipse.checkstyle_4.1.0-bin.zip」を解凍し、
Eclipseがインストールされているフォルダ内の「plugins」、「features」フォルダへ
それぞれコピーします。これでCheckStyleのインストールは完了です。
※インストール後にEclipseの再起動を行うとCheckStyleプラグインが有効になります。

メニューの「ウィンドウ」 > 「設定」をクリックし上記画面を表示後に「Checkstyle」をクリックします。
標準で「Sun Checks」、「Sun Checks(Eclipse)」が定義されています。
それぞれにSun推奨、Sun推奨(Eclipse対応)のコーディング規約が盛り込まれています。
独自にコーディング規約を作成したい場合、簡単な方法は「Sun Checks(Eclipse)」を選択後に
上記の赤丸部分「Copy」をクリックします。

上記の青丸部分で名称(任意)を決定後に「OK」をクリックすれば独自のコーディング規約の
元ができます。この時点では「Sun Checks(Eclipse)」の規約と同様のチェック内容です。

次に独自のコーディング規約を編集を行います。
上記でコピーして作成したコーディング規約(青丸部分)を選択して「Confugure」をクリックします。
※青丸部分のアイコンが鍵マーク以外の場合、編集ができることを意味します。

左記の内容を選択後に「Add」をクリックすると追加、右記の内容を選択後に「Remove」を
クリックすると削除、「Open」をクリックすると編集する画面が表示されます。
無効にしたいチェックがある場合は「Enabled」のチェックボックスを外す事で無効になります。
最後に「OK」をクリックすれば設定が有効になります。

上記で作成したコーディング規約をチーム等で共有するために作成した設定のエクスポート、
インポート方法を説明します。

作成したコーディング規約をエクスポートする方法は上記画面のようにエクスポートする
規約を選択後に「Export」をクリックすればエクスポート(XML)できます。
次にエクスポートした規約(XML)をインポートするには上記青丸部分「New」をクリックします。

上記画面のようにTypeを「External Configuration File」、Nameに規約の名前(任意)、
「Browse」をクリックして規約(XML)を指定して、赤丸部分「OK」をクリックすればインポートが完了です。

前提条件：CheckStyleを反映するプロジェクトを作成していること。
※Eclipseでプロジェクト作成方法を参照してください。

プロジェクトを右クリック後に「プロパティ」をクリックし「Checkstyle」をクリックします。
上記画面の「Checkstyle active for this project」にチェックをつけると
Checkstyleが有効になり、「Configure」をクリックするとコーディング規約が指定できます。
最後に「OK」をクリックすればCheckstyleが有効になり対象プロジェクトをチェックします。

Eclipseプラグインに関連する書籍をいくつか紹介します。