java - ローカル変数の Javadoc?

Question

簡単な質問: ローカル変数の Javadoc を作成することは可能ですか? （Eclipseでローカル変数にカーソルを合わせたときに、ローカル変数の説明が必要です）ヒントをありがとう:-)

score 11 · Accepted Answer

を使用して実行できますAnnotations。

次のような単純な注釈タイプを作成します。

@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.LOCAL_VARIABLE)
@interface LocalVariableDocumentation {
    String value();
}

そして、それをローカル変数で使用します。

@LocalVariableDocumentation("A very important object!")
Object anImportantObject;

Eclipse はツールチップに注釈を表示します。

score 5 · Accepted Answer

5

いいえ、JavaDoc 生成では無視されるため、サポートされていません。

于 2012-05-16T06:27:51.390 に答える

score 4 · Accepted Answer

ローカル変数は、その使用法の数行上で宣言する必要があります。必要に応じて、通常のコメントを使用してください。しかし、もっと重要なことは、メソッドを短くし、わかりやすい名前を付け、必要な場合にのみ宣言することです。ほとんどの場合、ローカル変数をコメントする必要はまったくありません。

好む

int numberOfBooks = books.size();

以上

// the number of books
int n;
... // 50 lines of code
n = books.size();

score 2 · Accepted Answer

それが可能な唯一の方法は、グローバル変数を使用することです。ローカル変数に JavaDoc のアノテーションを付けることはできません。

score 2 · Accepted Answer

ローカル変数へのリンクを作成するだけです

String someLocalVariable;
/**
 * This a local variable: {@link #someLocalVariable}
 */

6 に答える 6