我在SO Tavern中看到了这个问题,所以我在这里发布问题。我认为这是一个有趣的问题。(当然,它不属于SO,但是我认为在这里还可以。)
您是否在代码注释中添加了句点(或者,正如OP所写,“句号”)?
为了保持相关性,为什么?
我在SO Tavern中看到了这个问题,所以我在这里发布问题。我认为这是一个有趣的问题。(当然,它不属于SO,但是我认为在这里还可以。)
您是否在代码注释中添加了句点(或者,正如OP所写,“句号”)?
为了保持相关性,为什么?
Answers:
句号用于结束句子,但是如果注释只包含一个被代码包围的句子,那么我认为句号是不必要的。有时我什至不大写首字母。另一方面,详细的多行注释确实需要完整的标点符号。
// This function returns an average of two integers. Note that it may
// return an irrelevant result if the sum of a and b exceeds the int
// boundaries.
int avg(int a, int b) // make it static maybe?
{
// A better algorithm is needed that never overflows
return (a + b) / 2;
}
是的,因为注释是英文的,并且正确的英文使用标点符号。
您是否在代码注释中添加了句点(或者,正如OP所写,“句号”)?
为了保持相关性,为什么?
出于同样的原因,我在编写“普通”文本时添加了它们-它们是书写语言的一部分,因此它们不应该有什么特别之处。在写一个句子(一行)注释以及整个段落时,我会平等地使用它们。
源代码不是普通文本,因此我们使用不同的规则。简单;-)
如果您发表评论,则希望它们以英文书写。在这种情况下,应该正确打标。否则会很懒。
如果我写完整的句子(或更多),则可以。如果我不这样做,则有时不这样做,但通常还是可以。
我有时还会发疯,并使用感叹号,问号等;)
至于为什么,部分原因是因为我很特别,部分原因是我发现适当的标点可以增加很多清晰度。
这取决于。如果我写了一段大而恰当的段落来解释代码块的功能,那么我会像其他任何适当的文章一样正确地标点。OTOH,当我只注释一行代码时,我就不会。
为什么?-类似于为什么我用适当的写作方式写电子邮件,而我可能在SMS消息中使用速记句子。在一种情况下,我坐下来编写适当的文本块,因此我只是自动“正确地执行了它”,而在另一种情况下,这只是一个简单的注释。
我代码中的真实示例:
快速注释评论:
// check for vk_enter
“正确的”方法文档:
// This method sets up a workspace tab with the given name. Each MDI window has a parent
// workspace specified when it's saved. The code which loads each MDI window then point it to
// the correct workspace.