eclipseでjavadocを快適に書くためのショートカット,プラグイン等
スポンサーリンク
Eclipseのjavadocを書く速度を上げたいです.そのためにキーバインドを設定しました.
javadocショートカット
No | キーバインド | 操作 | 既存or自分で設定? |
---|---|---|---|
1 | Alt+Shift+J | javadocコメントを挿入 | 既存 |
2 | Ctr+X, Ctr+J | javadoc生成 | 自分 |
3 | Ctr+C,Ctr+X,Ctr+M | 既存getter/setter メソッドのjavadocコメントを生成 | 既存 |
javadocコメントの挿入方法
コメントを挿入したいメソッドやフィールドの宣言文上にカーソルがある状態でAlt+Shift+J.
javadocの文章を改行したい時は
javadocはHTMLとして生成されるので,javadocコメントの改行したいところで<br>
と記入.
補足 LimyEclipseについて
pleiades All in Oneをインストールしてeclipseを設定した場合,ついてくるプラグインの一つにLimyがあります.これは,javadocを簡単に生成しやすくするものです.例えば,getterやsetterなどのjavadocは典型的なパターンが決まっている場合が多いので,Limyでその辺を自動化すればいいじゃん,というわけです.上の表の3番目のショートカットを使うと,今のファイルの既存getter/setterすべてにコメントを自動付加できます.
Limyでのコメント付加の手順
- フィールドを宣言します.
private int hoge;
- フィールドの宣言文にカーソルをおいてjavadocコメントを挿入(
Alt+Shift+J
).
/** * */ private int hoge;
- コメント内にフィールドの名称を記入.
/** * ほげ */ private int hoge;
- どこでもいいので,
Alt+Shift+S
で右クリックメニューを呼ぶ r
をおしてgetter/setterを生成,の実行- 生成したいものにチェックつけて完了.
- メソッドが出来たのを確かめ,
Ctr+C,Ctr+X,Ctr+M
でコメント生成 - コメントが出来た.このなかの「ほげ」の部分はフィールドのjavadocと同じ物が入ります.
/** * ほげを取得します。 * @return ほげ */ public int getHoge() { return hoge; } /** * ほげを設定します。 * @param hoge ほげ */ public void setHoge(int hoge) { this.hoge = hoge; }
ショートカットに慣れればものの数秒でコメント生成も可能です.一度は試してみてはいかがでしょうか?