Question

我正在教授一门高级软件工程课程，并正在审核每个学生的代码。我的一些学生已经养成了在其他地方添加注释的习惯，即在每个右边括号中添加注释以识别语句类型，例如：

if (x > 3) {
  y = 10;
} //if

我告诉学生们要关注Android code style guidelines，这对这种做法一无所知。我应该告诉他们不要这样做（除了个人不喜欢），还是应该允许？

Answer 1

评论用于澄清代码并提高可读性。对于大多数合理的软件开发人员来说，这个陈述是“if”已经足够清楚了。此外，许多IDE和编辑器会自动突出显示这些括号，因此注释不是必需的。通常，您应该保存注释以描述哪些方法，类和变量（例如在Javadoc中），或者方法中的子例程将执行哪些操作。这是基于确保您添加的所有内容改进代码的一般准则。

Answer 2

告诉他们他们应该假设审核代码的人知道语言语法以及如何编程。评论应该是罕见的，指出并解释一些奇怪的和不明显的代码部分（例如某些库提供的api被窃听并且需要一些变通方法/黑客攻击）。我们有文档（和单元测试）来解释如何使用以及代码应该如何表现。出于教育目的，您可以编写充满这种“评论文档”的小班/模块，将其交给学生，并询问他们从这些评论中学到了什么。

Answer 3

嗯，很可能这最终将基于个人偏好进行讨论 - 这不在stackoverflow的范围内。但无论如何我会回答：

在我看来，这是一件坏事 - 出于多种原因。

它弄乱了代码。那里的评论越多，它的可读性就越低。一行中的一个}立即告诉我，最后一个块在这里结束。随着评论背后，有更多的阅读 - 没有额外的信息（但人们会读取，因为他们不知道评论不包括任何信息......因为人们倾向于自动阅读所有内容）< / p>
导致草率缩小。毕竟，这甚至可能是人们首先开始这样做的原因。
这是不必要的 - 如果我以一致的方式对代码进行处理，则没有必要注意关闭的内容，只需要到达具有相同缩进级别的最后一个语句的位置就可以很容易地看到它是。在大多数情况下（unbless你是反向缩进（或任何被称为），我完全不喜欢）这应该很容易，因为之间没有任何东西......
它会导致更大的文件大小。在现代系统上可能无效，但仍然存在。

Answer 4

每次都是矫枉过正。它取决于缩进的级别和函数的长度，但这些通常是您需要退回并重构的标志。我明确这样做的唯一一次是C ++中的命名空间

评论每个正确的支撑好/坏风格？

4 个答案: