いくつかのコード支援機能があります。
フィールドのGetter/Setterメソッドを自動生成(適切なJavadocコメント付)
既存Getter/SetterメソッドのJavadocコメントを自動修正
Javaコードの先頭に定型文(ライセンス定義など)を一括挿入
適切なコメントが付いたメソッドのJavadocコメントを自動生成
ファイルの文字コードを一括変換
実装クラスに応じたインターフェイス定義を自動生成
Ctrl+C Ctrl+X Ctrl+A
多くのJavaファイルに使われているであろうGetter/Setterメソッドですが
その管理に手を焼いている人も多いのではないでしょうか。
Eclipseを使っていれば、Getter/Setterメソッドは自動生成してくれるのですが
Javadocコメントに関しては、正直有用なコードを吐き出してくれません。
このコマンドを使うと、わかりやすいコメントを持ったGetter/Setterメソッドを生成することが出来ます。
/**このようなフィールドがあるクラスに対してこのコマンドを実行すると、
* フィールド
*/
private int field;
/**今まで手動でこういったコードを書いていた人は、
* フィールドを取得します。
* @return フィールド
*/
public int getField() {
return field;
}
/**
* フィールドを設定します。
* @param field フィールド
*/
public void setField(int field) {
this.field = field;
}
Ctrl+C Ctrl+X Ctrl+M
上のコマンドは、新規でプロジェクトを始めるときには有効ですが
全てのフィールドに対してGetter/Setterメソッドを再生成してしまうので
既存コードに使うわけにはいかないかもしれません。
そんなときはこのコマンドを使います。
これは、既存のGetter/Setterメソッドに対して
Javadocコメント部分のみを生成（更新）します。
Ctrl+C Ctrl+X Ctrl+H
Javaコードの先頭に定型文を一括挿入します。ライセンス定義を埋め込むときなどに便利です。
Package Explorer などで、対象とするJavaファイルを選択します。
ディレクトリやプロジェクト単位でまとめて選択してもOKです。
選択した状態でこのコマンドを実行すると、
対象となるJavaファイルの先頭に共通のヘッダを埋め込むことが出来ます。
なお、一度ヘッダを埋め込んだJavaファイルに対して再度コマンドを実行しても
そのファイルは更新されません。つまり、毎回プロジェクト単位でまとめてコマンドを実行しても
初回以降はそれほど時間が掛からないという事です。
この機能を使うには、Preference ページの LimyEclipse/code タブ上でJava Header Text File にヘッダファイルを指定しておく必要があります。
ヘッダファイルにはいくつかのタグが使えます。
日付に置き換えます。例) 2007/05/15
既存のJavaファイルのヘッダに日付が存在すればそれを使用し、無ければ現在日付を使用します。
時刻に置き換えます。例) 2007/05/15 10:20:30
既存のJavaファイルのヘッダに時刻が存在すればそれを使用し、無ければ現在時刻を使用します。
現在年に置き換えます。
プロジェクト名に置き換えます。
通常はEclipseのプロジェクト名を使用しますが、
JavaプロジェクトのProperyページにある Limy タブ上でProject Name を設定してある場合はそちらを優先します。
これは、複数のプロジェクトで同じプロジェクト名を使用したい場合などに使って下さい。
ファイル名に置き換えます。
パッケージ名に置き換えます。
クラス名に置き換えます。
OSユーザ名に置き換えます。
Shift+Alt+J
Eclipse に標準で付いてくるJavadoc生成機能（Shift+Alt+J）は
それなりに便利ですが、それをさらに拡張したのがこれです。
public void getRecords(Connection conn, String userId) throws SQLException {
...
}
↑このようなコードに対して、拡張Javadoc生成コマンドを実行すると…
/**
* @param conn DB接続
* @param userId ユーザID
* @throws SQLException SQL例外
*/
public void getRecords(Connection conn, int userId) throws SQLException {
...
}
こんな風に、パラメータや例外に応じた文言を自動的に挿入してくれます。
ただし、これらの文言は予め登録しておく必要があります。
Preferences の Code セクションに、Javadoc Comment File という欄があります。
まずここで、文言を登録しておくファイル(プロパティ形式)を指定します。Edit... ボタンで、このファイルを編集するダイアログが表示されます。
New Addition ボタンを押すと、空のレコードが一つ登録されます。
これを編集して文言を登録していくことになります。
例えば先程の例だと、以下の3つを登録します。
Type = Class ClassName = Connection Field Name = Javadoc Commant = DB接続
-
Type = int ClassName = Field Name = userId Javadoc Commant = ユーザID
-
Type = Exception ClassName = SQLException Field Name = Javadoc Commant = SQL例外D
こんな感じで、必要に応じて文言を登録していけば
どんどん便利になっていくはずです。
Beanクラス等のコンストラクタに対して、文言を登録していなくても
Javadocコメントを生成する機能を付けました。
class ClassA {
/** 日付 */
private Date date;
/** 表示文字列 */
private String dispString;
public ClassA(Date date, String dispString) {
...
}
}
このようなコードに対して、拡張Javadoc生成コマンドを実行すると…
/**
* @param date 日付
* @param dispString 表示文字列
*/
public ClassA(Date date, String dispString) {
...
}
というJavadocコメントを自動生成してくれます。
このとき、date や dispString は文言として登録しておく必要がありません。
コード中のフィールドJavadocコメントから自動で文言を拾ってきます。
ファイルの文字コードを一括で変換します。
Package Explorer でファイルやフォルダを選択してコマンドを実行すると、
変換後の文字コードを入力するダイアログが表示されます。
変換前の文字コードは、プロジェクトデフォルトの文字コードに固定されます。
※ ファイル(フォルダ)単位の文字コードには対応していません！
文字コードを入力してOKを押下すると、ファイルの文字コードが一括で変換されます。
Undo機能は付いていないので慎重に行って下さい。
Ctrl+C Ctrl+X Ctrl+I
実装クラスに対応するインターフェイス定義を自動生成します。
EJBに始まり、最近ではあらゆる場面でこのような
「インターフェイス <=> 実装クラス」を対で使うことが多いので
その手間を軽減させる為にも使ってみて下さい。
|
|