クリーンアップで、ソースコードをクリーンに!
あれこれソースコードを修正していると、どうもどことなく「きれいじゃない」感じになってきませんか? 例えば、使ってないソースコードがどこかに残っていたり、繰り返し文が1行しかないのに{}でくくってあったり、フィールドがprivateであったりなかったり、自身のインスタンス内のメソッドを呼び出すのにthisを書いてあったりなかったり……。
こういう「間違いではないんだけど、どことなく不統一で適当な感じ」というのは、どうもソースコードを汚く見せてしまいます。自分だけならまだしも、人に見せるような場合には、もう少しきれいにしておきたいですね。そんなときに役立つのが、<ソース><クリーンアップ>メニューです。
これは、ソースコードの細かな部分をチェックし、きれいに整えてくれるというすばらしい機能です。が、使い方が少々難しい。メニューを選ぶと、いくつものタブが並んだ、かなり複雑そうなウインドウが現れます。一度に覚えるのは大変そうですが、ポイントだけ把握しておけば、十分使えるようになります。
「コード・スタイル」タブ |
●「コード・スタイル」タブ
ここが一番わかりにくいかも知れません。繰り返し構文や条件構文の{}の付け方、Java5からサポートされた新しいforの使用、変数のfinal宣言などを設定します。よくわからなければ、「すべて選択」ボタンで全部ONにしてしまいましょう。
if/while/for/doステートメントでブロックを使用――これらの構文で{}を使って記述するルールを設定します。常に{}でくくるか、returnやthrow文が1つだけの場合は使わないか、1行だけの処理の場合は使わないかを選択できます。
forループを拡張に変換――コレクション(ArrayListなど)の1つ1つの要素をforで繰り返し処理するとき、Java5からサポートされた拡張for文を使う形に変換します。
条件を括弧で囲む――条件構文で{}を使う場合のルールを指定します。常に{}でくくるか、必要な場合のみ{}をつけるか設定できます。
使用可能な場合、修飾子'final'を使用――変数をなるべくfinal宣言するように変更します。
privateフィールド、パラメーター、ローカル変数――finalを付ける変数の種類を選びます。
「メンバー・アクセス」タブ |
●「メンバー・アクセス」タブ
クラス内のメンバー(フィールドやメソッド)を利用する場合のルールを設定するものです。thisやクラス名をつけて記述するかどうかを指定します。これも、よくわからなければ基本的に全部ONにしてしまいましょう。
非静的アクセス――ここにあるのは、インスタンス内のフィールドやメソッドを利用する際にthisを記述するかどうかを指定するものです。
静的アクセス――これは、クラスフィールドやクラスメソッドを利用する場合に、クラス名を指定して呼び出すようにするためのものです。
「不要なコード」タブ |
●「不要なコード」タブ
使われていないソースコード部分をチェックし自動的に削除するものです。これも、よくわからなければ全部ONでOKです。
未使用コード――全く使われていないimport文、フィールド、ローカル変数を削除するためのものです。
不要なコード――必要のないキャストや、$NON-NLIST$というタグを削除するためのものです。
「欠落コード」タブ |
●「欠落コード」タブ
こちらは反対に「足りないソースコード部分」を埋めるためのものです。注釈が抜けているもの、JavaBeansのシリアルバージョンIDが書かれていないものを自動的に埋め合わせます。
注釈――注釈しておくべき内容を保管します。メソッドのオーバーライドを示す@Override、非推奨を示す@Deprecatedといった注釈タグを自動的に埋め込みます。
シリアル・バージョンIDの追加――Java5では、JavaBeansクラスにはシリアル・バージョンIDのフィールドが用意されていないと警告を発するようになりました。これは、それを自動的に追加するものです。IDを新たに生成するか、デフォルト値を設定するかを選びます。
これらは、各タグごとにプレビュー表示が用意されていますので、チェックをON/OFFしてプレビューのソースコードがどう変化するかを確認すれば、その処理の働きがわかってきます。こまめにプレビューで表示を確認しながらON/OFFすると良いでしょう。
また、よくわからなければ「とりあえず全部ONにしてしまえ」といっておきます。これらの設定は、「ONとOFFのどちらがいいか」というよりも「全体で統一した書き方にする」ということが一番大切なのですから。
一通り設定して「次へ」ボタンを押すと、どのようにソースコードが修正されるかがプレビュー表示されます。ここで内容を確認し、「終了」ボタンを押せばソースコードが修正されます。