关于基本类型的Java约定

Question

原始类型的Java约定是什么？如果我正确地命名它，我应该记录每种原始类型吗？

/**
 * This is the variable that handles whether or not a person has turned on a light.
 */
private boolean toggleLight = false;

在我看来，这似乎绝对矫枉过正，如果有人有源或只是简单的先前知识，那么我将非常感激。

Answer 1

我认为，这取决于您所在的团队，不同的公司甚至项目都有不同的“标准”。我个人并不打算评论每个变量，特别是因为变量往往是私有的。如果变量是公共的，那么我将对它进行注释，使其出现在我的Javadoc中。

同样适用于方法，如果它是一个私有方法我不打扰评论，如果它是显而易见的，我也不评论setter和getters，只有逻辑的方法。

正如我所说，它通常取决于您编码的团队。

Answer 2

这与原始类型无关。您自己给出了一个很好的例子：名称toggleLight不是不言自明的。添加评论，更好的是，更改名称。

我喜欢的另一个例子是float weight - 嗯，这个重量单位是多少？是 mass 中的重量，还是重量重要性。

Answer 3

这与java无关，它应该是公司特定的而不是程序语言的特色。如果您的团队决定记录每个变量，那就是这种情况。一般情况下，记录每种方法，特别是公共方法，以及IDE在使用它们时显示文档，一些公司也决定记录私有方法，如果方法很大且名称不足以描述，这可能是必要的。这个方法做了什么。

考虑文档格式很重要，因为有很多文档生成工具可以根据XML标签阅读文档中的特定模式。