原始类型的 Java 约定是什么？如果我正确命名，我应该记录每个原始类型吗？
/**
* This is the variable that handles whether or not a person has turned on a light.
*/
private boolean toggleLight = false;
在我看来，这绝对是矫枉过正，如果有人有资料来源或只是以前的知识，那将不胜感激。
问问题
102 次
3 回答
3
我认为这取决于你所在的团队，不同的公司甚至项目都有不同的“标准”。我个人懒得评论每个变量，尤其是变量往往是私有的。如果变量是公开的，那么我将对其进行注释，以便它出现在我的 Javadoc 中。
方法也是如此，如果它是一个私有方法，如果很明显，我不会评论，我也不会评论 setter 和 getter，只有带有逻辑的方法。
正如我所说，它通常取决于您正在编码的团队。
于 2013-01-29T14:11:22.843 回答
2
这与原始类型无关。你自己举了一个很好的例子：这个名字toggleLight不是不言自明的。添加评论，更好的是，更改名称。
我喜欢的另一个例子是float weight——嗯，这个重量是什么单位？它甚至是质量的重量，还是重量的重要性。
于 2013-01-29T14:16:04.973 回答
0
这与java无关，它应该是公司特定的而不是程序语言特定的。如果您的团队决定记录每个变量，情况就是如此。一般来说，最好记录每个方法，特别是来自 IDE 的公共方法在使用它们时显示文档，一些公司决定也记录私有方法，如果方法很大并且名称不足以描述，这可能是特别必要的该方法的作用。
考虑文档格式很重要，因为有很多文档生成工具可以根据 XML 标签读取文档的特定模式。
于 2013-01-29T14:12:23.113 回答