プラグインは機能ごとに分割されています。core は必須プラグインですが、
その他のプラグインは必要に応じて追加したり削除したりすることが可能です。
各プラグインは core 以外に依存していないからです。
Limy Eclipse Plugin 共通のプラグインです。
以下に示す各機能を使うには、このプラグインがインストールされている必要があります。
日本語対応プロパティエディタです。
大した機能はありませんが、Eclipse3.1標準のプロパティエディタに搭載されている
ハイパーリンク機能を使うことが出来ます。
プロパティファイルのキー上でCtrlキーを押すとアンカーが出るので
その状態でマウスをクリックすると、
そのプロパティを使用しているJavaソースを検索して対応位置にジャンプしてくれます。
なかなか便利です。
いくつかのコード支援機能があります。
まず、Eclipseのトップメニューに「Limy」というメニューが追加されます。
ここから使える機能を紹介します。
Package Explorer などで、対象とするJavaファイルを選択します。
ディレクトリやプロジェクト単位でまとめて選択してもOKです。
選択した状態でこのコマンドを実行すると、
対象となるJavaファイルの先頭に共通のヘッダを埋め込むことが出来ます。
なお、一度ヘッダを埋め込んだJavaファイルに対して再度コマンドを実行しても
そのファイルは更新されません。つまり、毎回プロジェクト単位でまとめてコマンドを実行しても
初回以降はそれほど時間が掛からないという事です。
この機能を使うには、Preference ページの LimyEclipse/code タブ上でJava Header Text File にヘッダファイルを指定しておく必要があります。
ヘッダファイルにはいくつかのタグが使えます。
日付に置き換えます。
既存のJavaファイルのヘッダに日付が存在すればそれを使用し、無ければ現在日付を使用します。
現在年に置き換えます。
プロジェクト名に置き換えます。
通常はEclipseのプロジェクト名を使用しますが、
JavaプロジェクトのProperyページにある Limy タブ上でProject Name を設定してある場合はそちらを優先します。
これは、複数のプロジェクトで同じプロジェクト名を使用したい場合などに使って下さい。
多くの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;
}
上のコマンドは、新規でプロジェクトを始めるときには有効ですが
全てのフィールドに対してGetter/Setterメソッドを再生成してしまうので
既存コードに使うわけにはいかないかもしれません。
そんなときはこのコマンドを使います。
これは、既存のGetter/Setterメソッドに対して
Javadocコメント部分のみを生成（更新）します。
Eclipse に標準で付いてくるJavadoc生成機能（Alt-Shift-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
こんな感じで、必要に応じて文言を登録していけば
どんどん便利になっていくはずです。
ちなみに、このコマンドはデフォルトでは何のキーバインドもされていません。
実行するには、何らかのキーに割り当てる必要があります。
Preferences の Keys セクションで登録しましょう。
Category : LimyEclipse Name : Limy Add Javadoc Comment
僕は、Alt-Shift-J に割り当てています。
これによりEclipseデフォルトのJavadoc生成機能は使えなくなりますが
このコマンドは内部で全く同じ機能を使用しているので
完全なアッパーコンパチブルになっているはずです。
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コメントから自動で文言を拾ってきます。
Velocityの簡易エディタがあります。
拡張子が .vm のファイルに関連付けられています。
今のところ、まだ色付けくらいの機能しかありません。