javadoc - Java 文档中的私有(private)成员变量

Question

为什么 getters/setters 使用的私有(private)成员变量应该在描述相应 getters 和 setters 的 javadocs 中指定它们的描述。

Answer 1

私有(private)变量的描述，如下所示:

/**
 * the name of this object.
 */
private String name;

... 不应包含其 getter 和 setter 的描述。它应该包含此变量的属性、不变量(例如永远不应该为 null)和类似内容。

---

编辑:啊，我误解了你的问题。你问为什么 getters/setters 的描述应该包含变量的描述，而不是相反。

他们不应该 - 甚至不必存在这样的变量。 getter 和 setter 应该描述它们所具有的效果，其中可能包括修改(或检索)此对象的某些抽象属性。此属性由私有(private)变量实现与此无关。