分類

コーディング支援

URL

http://eclipse-cs.sourceforge.net/

インストール方法

アーカイブを展開してできた\com.atlassw.tools.eclipse.checkstyle_3.4.1.0をC:\eclipse\pluginsにコピー

概要

  • ソースコードがコーディング規約に準拠しているかどうかをチェックする。
  • コーディング規約のチェックは、Javaファイルのセーブ(ビルド)時に行われ、 問題があればタスクリストに表示される。
  • Sunのコーディング規約が用意されている。

基本的な使い方

  1. コーディング規約の設定
    1. Eclipseのツールバーで
      [ウィンドウ(W)]-[設定(P)]-[CheckStyle]
      を選択するとコーディング規約の定義ができる。
    2. インストール時には、Sunのコーディング規約が定義されており、利用することができる。
    3. また、独自にコーディング規約を定義したり、コーディング規約のインポート・エクスポートを行うことができる。
    4. 設定内容に関しては、
      http://www003.upp.so-net.ne.jp/kaz-taka/checkstyle/
      が詳しい。
       
  2. コーディング規約の適用
     
    コーディング規約の適用は、プロジェクトごとに行う。
    Eclipseのパッケージエクスプローラでプロジェクトを左クリックして [プロパティ] を選択する。
    すると、Check Styleに関する設定項目があるので、プロジェクトに目的のコーディング規約((たとえばSun Checks)を適用するように設定する。
     
    後は、ctrl+s でソースコードをセーブ(ビルド)するごとにチェックされる。
    たくさんコーディング規約違反が出てくるので、修正にはJalopy?を使うと幸せ。

Sun Checksのカスタマイズ

基本的には、Sun Checksを使い、適用したくない箇所を追記する。

チェック項目属性設定内容詳細
[Size Violations]-[Maximum Line Length]ignore pattern^[ ]*[*][ ]*@Java Docで用いられるタグには、行の桁数制限をかけないようにする

「クラス情報が取得できません」対策

Antビルダーをプロジェクトのビルダーに登録すると、Check Styleが「クラス情報が取得できません」という警告を出すときがある(特に独自のExceptionについて)。
これは、/bin 以下が削除されてから、作られるまでの間にCheck Styleが動いているから。

1.プロジェクトのクリーン(/bin 以下を削除)
2.Check Style ビルダーによって構文規約をチェック(/bin 以下がないのでクラス情報が取得できません」となる)
3.Antビルダー(/bin 以下を再構築)

これを回避するには、[プロジェクト] の [プロパティ]-[ビルダー] で、[Check Styleビルダー]が一番最後に走るようにすればよい。(cf.EclipseとAntの連携?)

特定のパッケージをチェックしたくないとき

自動生成されたソースコードなどをチェックしたくないときには、プロジェクトのプロパティからCheckstyleのFile Set設定に入り以下のように設定する。

[v]Include .java$
[ ]Exclude src/com/foo/xsd/
  • srcから指定するのがミソ

Java


トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2006-02-18 (土) 00:29:41 (3178d)
ISBN10
ISBN13
9784061426061
Tex → Image Converter