Eclipseのクリーンアップ機能でコーディングスタイルを統一する

スタッフ (2009年8月 6日 12:55)

今回は、Eclipseのクリーンアップ機能についてご紹介します。

チームでアプリケーション開発を行う場合は、コーディングスタイルなどが
決められていることが多いと思います。
でも、プログラマにはそれぞれコードを書く時の"癖"がありますね。

いくら　コーディングスタイルを守らねば！！　と気をつけていても
うっかり、規則から外れたコードを書いてしまうということもあるかと思いますので、
コーディング規則を守るためには、ツールによる手助けが欠かせません。

Eclipseには、コーディングスタイルの統一を手助けするための
様々な機能があり、その一つが今回ご紹介する『クリーンアップ』機能です。

この『クリーンアップ』機能は、Eclipse 3.2 の JDTで追加された機能です。
ソースコードの整形だけにとどまらず、Javaの構文にまで踏み込み、
コーディングスタイルを統一してくれます。

具体的には・・・

  • if/while/for/do ステートメントでブロックを使うかどうか
  • 条件文を括弧で囲むかどうか
  • フィールド・アクセスやメソッド・アクセスに'this'修飾子を使うかどうか
  • 未使用のインポート文を削除するかどうか
  • 欠落しているアノテーション（@Overrideなど）を追加するかどうか
などを統一することができます。


では、クリーンアップの実行手順について見ていきましょう。


(1)
クリーンアップの対象とするプロジェクトを「パッケージ・エクスプローラ」ビューで選択します。

(2)
コンテキスト･メニュー（右クリック）から「ソース」>「クリーンアップ」を選択します。

cleanup1.gif

(3)
「クリーンアップ」ダイアログが表示されるので、「次へ」ボタンをクリックします。
実際にクリーンアップを実行する前に、どのようなコード変更が行われるのかを
各ファイル毎に確認することができます。

cleanup2.gif


(4)
確認後に問題がなければ「終了」ボタンをクリックします。


これでクリーンアップは完了です。


今回はクリーンアップの対象として、1つのプロジェクトを選択しましたが、
プロジェクト内のあるファイルのみピンポイントでクリーンアップすることもできますし、
逆に複数のプロジェクトに対して一斉にクリーンアップをすることもできます。


ところで、今回のクリーンアップではEclipseがあらかじめ用意している
コーディングスタイルを適用しましたが、自分たちのチームで決められた
コーディングスタイルに合うようにカスタマイズすることもできます。


具体的なカスタマイズ方法については、次回の記事でご紹介したいと思います。
お楽しみに！


<追記>

次の記事はこちらです。
⇒Eclipseのクリーンアップ機能で適用するコーディングスタイルのカスタマイズ