Question

为什么getter / setter使用的私有成员变量在描述相应getter和setter的javadocs中指定了它们的描述。

Answer 1

私有变量的描述，如下所示：

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

...不应包含其getter和setter的描述。它应该包含这个变量的属性，不变量（比如永远不应该为null ），类似。

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

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

Answer 2

JavaDocs的目的是记录代码的公共API，以便开发人员可以了解如何使用您的类。它的目的不是公开代码的内部工作原理。记录私人成员只会让您更难阅读API文档。

私人会员的意义只对那些阅读/维护您的代码的人感兴趣。它们的目的应该通过明确，明确的命名和代码的一般优雅来传达。理想情况下，您甚至不需要评论。