1

メソッドの基礎となるフィールドに関する情報の重複を避けるために、アクセサーとミューテーター (ゲッター/セッター) の両方に javadoc コメントを書き込む方法はありますか?

例えば:

private float value;

/**
 * This value represents something.
 */
public float getValue () {
    return value;
}

/**
 * This value represents something.
 * @param    _value    A new value.
 */
public float setValue (float _value) {
    value = _value;
}

getter と setter の javadocs の「値」フィールドに関する情報を複製するのは、非効率的でエラーが発生しやすいようです....

4

1 に答える 1

3

次のように @see タグを使用して、あるメソッドのドキュメントから別のメソッドを指すことができます。

@see # setValue (float)

Eclipse は、コメントを簡単に作成できるように、javadoc のコード補完も提供します。

詳細については、@see http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#@see

于 2011-12-22T21:58:57.380 に答える