Eclipse/Checkstyleでコーディング規約を強制する

• Prev
• Next
• Eclipse

はじめに †

コーディング規約を強制するのに有効なPlug In発見。Checkstyle Plug Inです。
これのDefaultがSunのコーディング規約になっていますので、javaの基本的な規約を守らせることができます。
これを利用して規約を守る最低ラインを死守します。*1
Plug Inの導入は、http://www.atmarkit.co.jp/fjava/javatips/007eclipse004.html を見てください。

Plug Inはここから手に入る
http://sourceforge.net/projects/eclipse-cs/

規約を設定する †

java標準のコーディング規約は恐ろしく厳しく感じるので、必要性を感じない規約は無視できるように設定変更してみます。

20031121_LooseSun_3_1_1

20041211_LooseSun_3_5_0

1行の文字数を変更する †

• Sunの標準コーディング規約では1行は80文字以下に抑えなくてはいけないようです。
• javaDocコメントで「@see」を記述する際などどうしても1行が長くなるのでこの規約を80文字から240文字に変更します。

• 「Size Violation」→「Maximum Line Length」を「Edit Rule」します。

• 「max」を 80 → 240 に変更します。

TABの使用を許可する †

• Sunの標準コーディング規約ではTABはソース中に存在してはいけないようです。
• 「つかうだろ！」ってことで許可します。

• 「Whitespace」→「Tab Character」を「Delete Rule」します。*2

Magic Number のSevelityレベルを下げる †

• Magic Numberは使わない方が良いのかもしれませんが、for文で使用した際にも怒られるのはうっとおしいのでSevelityレベルをinfoに下げる。

• 「Coding Problem」→「Magic Number」を「Edit Rule」します。

• 「Sevelity」のレベルを「info」にします。
  • 「ignoreNumbers」にこのチェックを無視したい数値をカンマ区切りで記述していけば、チェックの対象から外せます。

引数でのfinal宣言チェックを行わない †

• メソッドの引数はどう考えてもfinalなので宣言してもいいけど、あまりにもうざいのでやめチェックを外す
• コンストラクタも同様・・・

• 「Miscallaneous」→「Final Parameters」を「Edit Rule」します。

• 「Sevelity」のレベルを「ignore」にします。
  • 「METHOD_DEF」がメソッドのチェック。これを外すとメソッドのチェックのみ行わない設定になる
  • 「CTOR_DEF」がコンストラクタのチェック。これを外すとコンストラクタのチェックのみ行わない設定になる

プロジェクトに規約を設定する †

• プロジェクトの「プロパティ」より「Checkstyle」を選択します。
• で「add」する。
  
• プロジェクトがサーブレットだとjspのworkで警告でまくるので、対象のファイルを

  [^_]+[^j]+[^s]+[^p]\.java$

  としてコンパイルされたjspを除外する。*3

[^T]+[^e]+[^s]+[^t]\.java$

ちなみにJUnitの場合は、こんな感じで除外。。。

• まぁ、つまるところただの正規表現なので・・・

備考 †