Java文档中的私有成员变量

getter/setter使用的私有成员变量为什么要在描述相应获取器和设置器的javadoc中指定其描述。Java文档中的私有成员变量

2011-03-28 Nivedha

谁说他们应该？只要getter/setter被记录下来，我没有理由复制私人领域的文档。 – 2011-03-28 07:28:15

但是在某些情况下，私人领域可能有也可能没有获得者或设定者。或者有些可能只有吸气剂。可能只是为了指定变量是否具有getter或setter，它们的描述需要包含在内。我只找到这个作为包含描述的唯一理由。让我知道如果我错了。 – Nivedha 2011-03-28 08:20:08

私有变量的描述，喜欢这里：

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

...不应该包含其getter和setter方法的说明。它应该包含这个变量的属性，不变式（如绝不能为空）等等。

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

他们不应该 - 甚至不必存在这样的变量。吸气人员和安装人员应描述他们所具有的效果，其中可能包括修改（或检索）此物体的某些抽象属性。这个属性是由私有变量实现的并不相关。

2011-03-28 08:05:48

JavaDocs的目的是记录代码的公共API，以便开发人员能够理解如何使用您的类。目的不是揭露你的代码的内部运作。记录私人成员只会让你的API文档更难阅读。

私人成员的含义只对那些阅读/维护您的代码感兴趣。他们的目的应该通过清晰明确的命名和代码的普遍优雅来传达。理想情况下，你甚至不需要评论。

2013-03-06 16:26:23 elgaz

回答