EclipseのCheckstyleプラグインのインストールと使い方です。
Checkstyleは、静的解析のプラグインです。ソースコードがコーディング規約を守っているかチェックしてくれます。
| 確認環境 ・eclipse 4.7/4.6 |
目次
- Checkstyleをインストールする
- Checkstyleをアクティブにする
- Checkstyleのチェック内容を確認する
- 独自のチェック構成を作成する
- チェック構成をエクスポートする
- チェック構成をインポートする
- Checkstyleのビューを表示する
Checkstyleをインストールする
１．Checkstyleをインストールする手順です。
「ヘルプ」>「Eclipse マーケットプレース」をクリックします。
※EclipseマーケットプレースはEclipseプラグインが登録されているサイトです。
以下は、Eclipseマーケットプレースのサイトです。
http://marketplace.eclipse.org/
２．「検索」の入力欄にcheckstyleと入力して「実行」ボタンを押して検索します。
Checkstyleプラグインの箇所で「インストール」ボタンを押します。
※すでにインストール済みの場合は、「インストール」ボタンが「インストール済み」になっています。
３．続きはウィザードに従って進めればOKです。
４．インストール中は、Eclipseの右下に進捗バーが表示されます。
５．以下の警告が表示された場合「インストール」をクリックします。
６．インストールが終了すると、Eclipseの再起動を求められます。
「今すぐ再始動」をクリックするとEclipseが再起動します。
Checkstyleをアクティブにする
１．Checkstyleをアクティブにする手順です。
プロジェクトを右クリックします。
２．「Checkstyle」>「Checkstyleをアクティブにする」をクリックします。
３．ソースコードを確認すると、チェックにひっかかった行が黄色になり、カーソルをあわせると理由が表示されます。
Checkstyleのチェック内容を確認する
１．Checkstyleのチェック内容を確認します。
「ウィンドウ」>「設定」をクリックします。
２．CheckstyleをクリックするとCheckstyleの設定画面が表示されます。
このサンプルでは、Google Checksがデフォルト設定されています。
チェック内容を見る場合、確認したいチェック構成を選択して「構成」ボタンを押します。
３．Checkstyle構成の画面です。現在適用されているチェック内容を確認できます。
独自のチェック構成を作成する
１．Checkstyleの独自のチェック構成を作成する手順です。
Checkstyleの設定画面を開きます。(「ウィンドウ」>「設定」>「Checkstyle」)
元となるチェック構成を選択して「コピー」を押します。
２．チェック構成の名前を入力してOKボタンを押します。
３．「グローバル・チェック構成」欄に作成したチェック構成が表示されました。
「デフォルトとして設定」ボタンを押すとデフォルトのチェックがつきます。
チェック内容を変更する場合は変更したいチェック構成を選択して「構成」ボタンを押して変更します。
チェック構成をエクスポートする
１．チェック構成をエクスポートする手順です。メンバーに配布できます。
Checkstyleの設定画面を開きます。(「ウィンドウ」>「設定」>「Checkstyle」)
エクスポートしたいチェック構成を選択して「エクスポート」を押します。
ファイルを保存するダイアログが表示されるので、ファイル名は任意で、拡張子はxmlにして保存します。
チェック構成をインポートする
１．チェック構成をインポートする手順です。
Checkstyleの設定画面を開きます。(「ウィンドウ」>「設定」>「Checkstyle」)
「新規」ボタンを押します。
２．「型」は内部構成にして任意の名前を入力し、「インポート」ボタンを押します。
ファイル選択のダイアログが表示されるのでチェック構成のxmlファイルを選択してOKボタンを押します。
３．グローバル・チェック構成の欄にインポートしたチェック構成が表示されます。
「デフォルトとして設定」を押してデフォルトのチェックにします。
Checkstyleのビューを表示する
１．ビューにCheckstyleの情報を表示することができます。
「ウィンドウ」>「ビューの表示」>「その他」をクリックします。
２．「Checkstyle 違反」、「Checkstyle 違反グラフ」をクリックしてOKボタンを押すとビューに表示されます。
３．以下は、「Checkstyle 違反」の表示です。
４．以下は、「Checkstyle 違反グラフ」の表示です。
関連の記事
Eclipse インストール済みプラグインの確認方法
Eclipse 更新サイトがあるプラグインのプラグイン追加手順
Eclipse 手動でプラグインを追加する方法
Eclipse findbugsのインストール手順