Question

你在第二或第三人写评论吗？

// go somewhere and do something (2nd person comment)

或

// goes somewhere and does something (3rd person comment)

Answer 1

我经常倾向于说医生风格：

// Now we take $x and check whether it's valid for this pass

Answer 2

绝对是第三人称风格。

Answer 3

一个有用的提示：尝试尽可能保持每个评论的自包含。例如，这种形式：

// First, mumble the frabbitz.

blah blah

// Second, foobar the quux

blah blah

这是一个很好的叙述，但是编辑代码变得更加困难，因为“第一”和“第二”部分可能会变得不正确。最后，他们不会在评论中添加那么多内容，但会以脆弱的方式使它们相互关联。

Answer 4

我的观点是你应该使用你觉得最舒服的任何风格。

嵌入式注释旨在供您和其他开发人员阅读，以了解代码的实现细节。只要它们清晰易懂，如果它们的风格有点不寻常，语法有点差，或者有一些拼写错误就足够了。正在阅读它的人应该更关心这些事情。

提取用于形成API文档的注释值得更多关注样式，语法和拼写的细节。但即使在这里，准确性和完整性也更为重要。

Answer 5

我有时会以第一人称发言，就像这样

/*
Usage:  
set_position(0.5, 0.5);  // im in the center
set_position(0.0, 1.0);  // im in the lower,left corner
*/

Answer 6

这可能取决于有多少人正在编辑代码以及用于何种目的。在我自己的代码中（尽管如此，我仍然可以使用“我”），我可以随意添加一些个人评论。在一个公共项目中，评论应该以社区风格为目标，“我”可能不合适。

请注意，评论是脆弱的，许多现代权威（例如清洁代码）表明函数和字段应该带有有意义的名称。但是，当然，有很多地方解释性评论仍然至关重要。