coding-style - 评论样式 : Imperative or third person

Question

我有一个关于编程和英语语言的问题:在评论单行代码时是使用第三人称还是命令式。
假设在命令式语言中的以下代码行应该被注释:

object.doSomething();

我评论这一行的方法是使用第三人称将评论放在它后面，这样将是一个包含该行作为主语的普通英语句子:

object.doSomething(); // does (referencing to the line of code) some action

但是由于我们使用的是命令式语言，因此实际上“命令”了计算机，甚至可以考虑将注释放在代码之前并使用命令式:

//Do some action:
object.doSomething();

当需要注释彼此相关的多行时，这甚至很有用。

我个人更喜欢第一种风格，但我经常不确定要使用什么风格。如果有人能在这里写下他们的个人经历，那就太好了。

Answer 1

第一种方法绝对是更合适的评论方法，因为人们会阅读您的评论，重要的是他们尽可能容易阅读。 //Do something听起来您是在与计算机交谈，而不是在解释代码的作用。