はじめに
目的
* Java ソースファイルが決められた規約に従っているかをチェックできる
静的解析ツール
[1] Checkstyle プラグイン ★今回扱うのはコレ★ [2] FindBugs プラグインhttp://blogs.yahoo.co.jp/dk521123/32316466.html
[3] PMDhttp://blogs.yahoo.co.jp/dk521123/36135343.html
[4] Jlinthttps://hondou.homedns.org/pukiwiki/pukiwiki.php?Eclipse%20Jlint
ダウンロード
* 以下から、「net.sf.eclipsecs-updatesite_5.6.1.201306282206-bin.zip」が取得できるhttp://sourceforge.net/project/showfiles.php?group_id=80344&package_id=107587
インストール
[1] 更新サイトによるインストール
* Eclipseの[Help]-[Install New Software…]を選択し、「Work With」に以下のURLを入れてインストールするhttp://eclipse-cs.sf.net/update/
* 詳細は、更新サイトによるインストールは、以下を参照のこと。http://android-blog.smartphone-app.net/archives/175
[2] 手動インストール
* 手動インストールは、以下を参照のこと。http://www.javadrive.jp/eclipse3/plugin/index1.html
手順
[1] ダウンロードしたファイルを解凍する ■解凍後のフォルダ構成例 * net.sf.eclipsecs-updatesite_5.6.1.201306282206-bin | +- features(フォルダ) ... ※1 | | | +- net.sf.eclipsecs_5.6.1.201306282206.jar | +- plugins(フォルダ) ... ※2 | | | +- net.sf.eclipsecs.branding_5.6.1.201306282206.jar | +- net.sf.eclipsecs.checkstyle_5.6.1.201306282206.jar | +- net.sf.eclipsecs.core_5.6.1.201306282206.jar | +- net.sf.eclipsecs.doc_5.6.1.201306282206.jar | +- net.sf.eclipsecs.ui_5.6.1.201306282206.jar | +- artifacts.jar +- content.jar +- site.xml [2] Eclipseがインストールされているフォルダ内の「plugins」、「features」フォルダに、 それぞれ※1、※2内にあるjarファイルをコピー&ペーストする [3] コマンドプロンプトを立ち上げ、eclipse.exeがある位置まで移動し、 「eclipse -clean」を入力し、Eclipseを再起動
Eclipseの設定
* インストール後に行う。
手順
[1] Eclipse で、[Window]-[Preferences]-[CheckStyle] を選択 →「Global Check Configurations」欄に注目すると、デフォルトで以下のコーディング規約が備わっている ~~~~ * Sun Checks : Sun推奨 * Sun Checks(Eclipse) : Sun推奨(Eclipse対応) ~~~~ 実際に使用には、カスタマイズして、不要なルールは無効にしたかったり、変更したかったりしたいので... [2] 「Sun Checks(Eclipse)」を選択し、「Copy」ボタン押下する [3] Nameに任意の文字列(例「Custom Sun Checks (Eclipse)」)を入力し、「OK」ボタン押下 [4] 「Set as Default」ボタン押下し、デフォルトに設定しておく [5] 「Configure...」ボタン押下し、例えば、無効にしたいルールのチェックを外し、「OK」ボタン押下 ※青丸部分のアイコンが鍵マーク以外の場合、編集ができることを意味する
ルールの修正
1行の文字数を変更する
Eclipseの設定の手順 [5]まで行い、以下を実行する * [Size Violations]-[Maximum Line Length]をダブルクリックし、 Generalタブのmaxを制限したい1行の文字列数を入力し(例えば「80」=>「150」) 「OK」ボタンを押しまくり。
使い方
Checkstyle によるチェック
[1] チェックしたいプロジェクトを右クリック [2] [CheckStyle]-[Activate Checkstyle]を選択する →ソースの右に、「虫眼鏡+黄色三角!アイコン」が表示され、マウスのフォーカスをあわせると、理由も表示される。
参考文献
http://www.develop-memo.com/java/eclipseplugin/checkstyle.htmlhttp://nabeshodai.web.fc2.com/eclipse/checkstyle/checkstyle.html
http://dekuyou.ddo.jp/knowledge/?Eclipse%2FCheckstyle%A4%C7%A5%B3%A1%BC%A5%C7%A5%A3%A5%F3%A5%B0%B5%AC%CC%F3%A4%F2%B6%AF%C0%A9%A4%B9%A4%EB