戻る


参考サイト

http://sourceforge.net/projects/eclipse-cs/                                       ダウンロードページ

http://www003.upp.so-net.ne.jp/kaz-taka/checkstyle/3.5/index.html      Checkstyleドキュメント 日本語訳

http://works.nri.co.jp/solution/open_pdf/checkstyle.pdf                         利用ガイド


CheckStyle導入

CheckStyleとは?

■ Checkstyle とは Java ソースファイルが決められた規約に従っているかをチェックする、オープンソースのソフトウェアです。
 Checkstyle では

のような、コードの「見た目」に関する規約や、 のように、企業の情報システムなどではおそらく必須となるであろう規約類だけでなく、 など、クラスの設計までかかわる、コーディング内容そのもののチェックまでをカバーしようとしています。
設定はXMLベースの設定ファイルで行い、命名などの規約は正規表現による設定が可能です。また、公開されているAPIを使用して独自のチェッククラスを実装することも可能です。

 

EclipseプラグインCheckStyleの設定を行う

利用ガイド:http://works.nri.co.jp/solution/open_pdf/checkstyle.pdf

利用ガイドを参考にEclipseプラグインのCheckStyleの設定をしてみようと思います。

 

まずはダウンロードしてみよう

ダウンロードページ:http://sourceforge.net/projects/eclipse-cs/

ただし、Eclipse 2.x 系は 3.3.2 まで。Eclipse 3.x 系は 3.4.0 以上を使う。という制約があるので今回は3.3.2をダウンロードする。

[View ALL Project File]を押すとダウンロードできるファイルが全て表示されるので[Download com.atlassw.tools.eclipse.checkstyle_3.3.2.0.zip]を選択する。

あとは好きな場所にファイルを保存すればよい。

 

インストールしてみよう

ダウンロードしてきた[com.atlassw.tools.eclipse.checkstyle_3.3.2.0.zip]というフォルダを解凍する。解凍したフォルダをエクリプスのフォルダの直下にあるpluginsフォルダの中にフォルダごと移動させる。

Eclipseを立ち上げてメニューバーの[ウィンドウ]→[設定]で設定画面を開きCheckStyleが追加されているか確認する。

 

CheckStyleを実行してみよう

Eclipseを立ち上げメニューバーの[ウィンドウ]→[設定]で設定画面を開き[CheckStyle]を選択して下の画面を表示します。

この画面はコーディング規約を設定する画面です。

どのようなコーディング規約にするかは[CheckConfigration]で指定されているファイルによって決まります。

EclipseプラグインのCheckStyleではGUIを用いてコーディング規約を設定することができます。

しかし、今回はコーディング規約を作るのが目的ではないのではデフォルトで用意されている「SunCheck」を使います。

なので、この画面で設定する項目は[Include rule names in violation messages]だけです。

 

「パッケージ・エクスプローラー」ビューでプロジェクトを選択して右クリックして「プロパティー」を選択します。

すると[CheckStyle]という項目が増えています。

[CheckStyle]を選択すると下のような画面が表示されます。

この画面では、プロジェクトでどのコーディング規約を実行するかを設定します。

この画面で[Add]ボタンを押します。

 

すると、下のような画面が表示されます。

この画面はCheckStyleの実行設定(FileSet)を作成する画面です。

デフォルトではプロジェクト内の全ての[Java]ファイルに対してチェックが実行されるようになっています。

各ボタンの機能は以下のようになっています。

 

[Add]:チェック対象ファイルを追加することができます。

[Edit]:チェック対象ファイルを編集をすることができます。

[Remove]:チェック対象ファイルを削除することができます。

[Test]:チェック対象ファイル一覧を表示します。

[Up][Down]:同一ファイルを対象にInclude(対象)、Exclude(非対象)が複数設定されている場合画面下側に追加されている設定が優先(適用)されます。

                       その優先順位を設定するボタンです。

 

今回はデフォルトで設定されている全ての[Java]ファイルに対してチェックを行うことにします。

[File Set Name]には任意の名前を設定します。

[Check Configuration]はコーディング規約の設定で定義したコーディング規約を選択します。(今回は[Sun Check]を選択します。)

設定が完了したらOKボタンを押して設定を適用させます。

 

プロジェクトプロパティ画面に先ほど設定したFileSetが追加されています。

[Enabled]のチェックボックスのチェックをはずす事でコーディング規約を適応するかしないかを選択できます。

ひとまずチェックを止めたいと思ったときはチェックボックスのチェックをはずせばよいです。

 

OKを押すとCheckStyleが実行されます。

以後、Eclipse上でファイル編集をし保存を行うとCheckStyleも同時に実行されます。

 

実行結果の出力はどうなっている?

実行すると画面にこのように表示されます。(タスクビューにも表示されます)

修正して保存する(CheckStyleを実行する)と問題は解決され表示されているマークも消えます。


20051004 チェックスタイルの設定ファイルの取込

チェックの仕方について、外部から提供されたファイルを取込事ができます

Import Plugin Configration で取り込めると思うが、ダメな場合は、Import Checkstyle Config にておこなってみるべし。

両者の違いはよくわからんですが…


戻る