这个评论结构的名称是什么？

Question

我有一段时间第一次教授 C++ 编程课程，并且在某种程度上基于基础书籍示例，我发现学生希望他们的所有评论都像这样位于行尾：

for (int count = 1; count <= days; count++) {   // Loop for each day
    organisms += organisms * increase;          // Compute organisms
    cout << organisms << endl;                  // Print out organisms
}

相反，我试图让他们使用专门的注释行，为此目的总结了几行代码：

// Update & display organisms for each day
for (int count = 1; count <= days; count++) { 
    organisms += organisms * increase;          
    cout << organisms << endl;                  
}

后一种非行尾注释样式有合适的名称吗？

Answer 1

除了表示行注释之外，您所要求的注释结构没有特定的命名约定，并且如何注释通常留给相关源代码的样式指南（如果有）。那篇维基文章甚至指出：//

注释提供的灵活性允许很大程度的可变性，但其使用的正式约定通常是编程风格指南的一部分。

与编码语法约定（如 OOP、函数、lambda 表达式等）不同，注释风格没有除块注释（有时称为C 风格注释）、行注释等之外的语法命名约定。

这是因为注释通常旨在注释某些内容，而不是作为代码本身的函数。

我说“典型”是因为您可以对版权等内容使用注释，或者帮助生成文档（通过JavaDoc 样式之类的方式）

不过，这些都是评论的“风格”，而不是语法结构的名称。

后一种非行尾注释样式有合适的名称吗？

不。这又是因为评论风格、结构和内容都是由作者决定的。如果愿意的话，人们甚至可以在评论中遵循五步抑扬格。

如果您必须给它一个“名称”，您可以将其称为 a ，single line concise functional comment就像您的示例一样；简洁的单行注释描述了该代码的功能部分的作用。

最终，你要教你的学生注释的真正目的是什么，职业程序员不需要注释每一行代码，就像字典不需要注释定义的每个部分一样。