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

Question

我在一段时间内第一次教授C ++编程课程，并且在某种程度上基于小学书籍的例子，我发现学生希望他们的所有评论都像这样结束：< / p>

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

除了//之外，您在if (some_array[i - 1] == 0) { // remember INDEX STARTS AT 0!! some_array[i - 1] = 1; // set to 1 if it equals 0 } 之外提出的评论结构的not具有example特定的单行评论，并且如何发表评论通常会留下到相关来源的风格指南（如果有的话）。

尽管如此，这对新程序员来说并不罕见;我看到一些例子：

uint8_t temp;

// Rotate first row 1 columns to left  
temp           = (*state)[0][1];
(*state)[0][1] = (*state)[1][1];
(*state)[1][1] = (*state)[2][1];
(*state)[2][1] = (*state)[3][1];
(*state)[3][1] = temp;

教授重要的是评论的目的是：注释。

例如，当您阅读某些材料时，某个单词可能会有一个脚注 ¹ ，但 ² 您 ³ 不会t ⁴ 参见 ⁵ a ⁶ 脚注 ⁷ 详细说明 ⁸ 每 ⁹ 字 ¹⁰ 。 ¹¹ 由于材料的作者希望读者对语言的语法和结构有基本的了解和理解，以便基本上读它，但可能不了解他们的领域的具体情况。或者在源代码的情况下，人们会注释一个代码区域，这些区域对于对该语言有基本了解的随意读者可能没有意义，如：

UICollectionView

学习编程的一部分是学习阅读代码并理解它正在做什么而不管注释说什么，因为编译器不关心注释。

但是，了解评论在凌晨2点的有用程度也很重要，即使在您自己的代码中也是如此。

希望能帮助你和你的学生。

^{1 - 这解释了一点 2 - 介词 - 除了
3 - 不是我 4 - 1字的含义不会
5 - 观察
6 - 字母表的第一个字母
7 - 脚注..见脚注 ₇
8 - 解释更多，或使车辆看起来不错 9 - 包罗万象 10 - 严重的是，如果书籍像某些代码一样被评论，那将是一场噩梦 11 - 完全停止!!!!}