评论风格：命令式或第三人称 [英] Comment style: Imperative or third person

问题描述

我有一个与编程和英语都相关的问题：在注释单行代码时是使用第三人称还是使用命令式。 假设使用命令式语言编写以下代码行，应对其进行注释：

object.doSomething();

我注释此行的方法是使用第三人称将注释放在后面，如下所示将是一个包含该行作为主语的普通英语句子：

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

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

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

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

我个人比较喜欢第一种风格，但我经常不确定该用哪种风格。如果有人能在这里写下他们的亲身经历，那就太好了。

推荐答案

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

这篇关于评论风格：命令式或第三人称的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！