Question

有没有办法为访问器和mutator（getter / setter）编写javadoc注释，以避免重复有关该方法底层字段的信息？

e.g：

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中的'value'字段重复信息似乎效率低且容易出错....

Answer 1

您可以使用@see标记从一个方法的文档指向另一个方法，如下所示：

@see # setValue (float)

Eclipse将帮助为javadoc提供代码完成，以便于创建注释。

详情请见@ http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#@see

如何使用javadoc访问器？

1 个答案: