web-dev-qa-db-ja.com

EclipseでJavadocコメントを生成する方法

可能な重複:
Javadocテンプレートジェネレータ

EclipseでJavadocコメントを生成する方法はありますか?もしそうなら、それは何ですか?

193
antony.trupe

私にとっては/**<NEWLINE>または Shift - Alt - J (または  - - J Macでは)アプローチが最も効果的です。

私はJavadocのコメントがソースコードに自動生成され、実際のコンテンツで更新されていないのを見るのが嫌いです。私の知る限りでは、そのようなjavadocは画面スペースの無駄に過ぎません。

IMOでは、詳細を入力しようとしているので、Javadocコメント・スケルトンを1つずつ生成する方がはるかに優れています。

341
Stephen C

Shift-Alt-JはEclipseでJavadocコメントテンプレートを作成するための便利なキーボードショートカットです。

クラス、メソッド、またはフィールド宣言でショートカットを呼び出すと、Javadocテンプレートが作成されます。

public int doAction(int i) {
    return i;
}

メソッド宣言でShift-Alt-Jを押すと、次のようになります。

/**
 * @param i
 * @return
 */
public int doAction(int i) {
    return i;
}
78
coobird

JAutoDoc

javadocとファイルヘッダをソースコードに自動的に追加するための Eclipse プラグイン。 Javadoc用に Velocityテンプレート を使用して、要素名から初期コメントを生成しますとファイルヘッダー...

36
antony.trupe

メニューのプロジェクト - > Generate Javadoc?

26
Mirek Pluta

Javadocが必要な場所に/** <NEWLINE>と入力すると、テンプレートが作成されます。

14
bmargulies