你用第二人称还是第三人称写评论？
// go somewhere and do something (2nd person comment)
或者
// goes somewhere and does something (3rd person comment)
问问题
1170 次
6 回答
21
我经常倾向于说医生风格：
// Now we take $x and check whether it's valid for this pass
于 2009-10-31T13:44:15.607 回答
7
绝对是第三人称风格。
于 2009-10-31T13:39:06.347 回答
4
一个有用的提示：尽量让每条评论保持独立。例如，这种形式：
// First, mumble the frabbitz.
blah blah
// Second, foobar the quux
blah blah
这是一个很好的叙述，但使编辑代码变得更加困难，因为“第一”和“第二”部分可能会变得不正确。最后，他们并没有在评论中添加那么多内容，而是让它们以一种脆弱的方式相互关联。
于 2009-10-31T13:45:58.833 回答
3
我的观点是，你应该使用你觉得最舒服的任何风格。
嵌入式注释旨在供您和其他试图了解代码实现细节的开发人员阅读。只要它们清晰易懂，它们的风格是否有点不寻常，语法有点差，或者有一些拼写错误都很重要。阅读它的人应该不在乎这些事情。
提取形成 API 文档的注释值得更多关注样式、语法和拼写的细节。但即使在这里，准确性和完整性也更为重要。
于 2009-10-31T14:19:57.697 回答
1
我有时用第一人称说话，像这样
/*
Usage:
set_position(0.5, 0.5); // im in the center
set_position(0.0, 1.0); // im in the lower,left corner
*/
于 2009-10-31T13:51:15.430 回答
0
这可能取决于有多少人正在编辑代码以及出于什么目的。在我自己的代码中（仍然是供公众查看的），我可以随意添加一些个人评论，也许使用“我”。在公共项目中，评论应该针对公共风格，“我”可能不合适。
请注意，注释很脆弱，许多现代权威（例如 Clean Code）建议函数和字段应该带有有意义的名称。但是，当然，在很多地方解释性评论仍然很重要。
于 2009-10-31T13:52:37.433 回答