CheckStyle

作成 2003/5/3

実行環境

CheckStyleプラグインとは?

コーディング規約のチェックをしてくれるプラグインです。 コーディング規約の設定と、チェックする範囲(フィルター)を指定しておくと、 コンパイルの警告、エラーと同じような感じで、コーディング規約違反の警告を出してくれます。

CheckStyleプラグインは、オープンソースのツールCheckStyleをEclipseに統合したものです(別途CheckStyle自体のダウンロードは不用です)。

CheckStyleプラグイン
http://www.atlas-sw.com/index.html

CheckStyle本家
CheckStyle

CheckStyleドキュメント翻訳
http://www003.upp.so-net.ne.jp/kaz-taka/checkstyle/

インストール

インストールはいつもの方法です。 CheckStyleプラグインのページからアーカイブをダウンロードし、 展開したフォルダをpluginsにコピーしてEclipseを再起動します。

CheckStyleの設定

ウィンドウ->設定->CheckStyleで、チェックする内容(コーディング規約)を設定します。

画面、CheckStyleの設定。いっぱいある〜

プロジェクトの設定

プロジェクトのプロパティー->CheckStyleで設定を行います。

Enable CheckStyleをチェックします

チェックするとこのプロジェクトに対してCheckStyleを有効にします。

Filterを指定します

チェックを行わないファイルを指定します。 例えば、hogeを追加すると、hogeパッケージ以下のファイルがチェック対象からはずれます。

画面、プロジェクトの設定

実行

実行というか、プロジェクトの設定を終えると、、、、 以降、コンパイルと同様、随時チェックされます。

画面、警告だらけ。。。

感想

これは使えそうです。 CheckStyleの設定を用意して各自インポートすれば(できる?試してないけど)、 チームでコーディング規約を徹底できます。 規約に従って気をつけながらコーディングするの けっこうストレスだし抜けが多いんで、こうやって自動的にやってくれると、気楽にできて何よりでは?


TOP