如何使用 javadoc 访问器？答案

【问题标题】：How to javadoc accessors?如何使用 javadoc 访问器？
【发布时间】：2012-01-26 11:06:50
【问题描述】：

有没有办法为访问器和修改器（getter/setter）编写 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 中重复有关“值”字段的信息似乎效率低下且容易出错......

【问题讨论】：

有一些关于这个话题的讨论here。
谢谢亲爱的。以为以前有人问过，但找不到。我投票结束我的问题。

标签： javadoc getter-setter accessor mutators

【解决方案1】：

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

@see # setValue (float)

Eclipse 还将帮助为 javadoc 提供代码补全，以便轻松创建 cmets。

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

【讨论】：