comments - 一般 - 首选评论目标

Question

我非常喜欢评论我的代码以供我自己引用，而且因为我(大部分)项目都是开源的。

我目前的评论好像我是叙述者:

// Check if y is higher than x.

我应该像在和一群人说话一样评论吗？:

// Now we check if y is higher than x.

这不是什么大问题，我只是想了解人们的评论偏好

Answer 1

我更喜欢以第三人称发表评论，所以这听起来更像是一个程序化的故事。这在过去不仅在调试我自己的代码而且调试其他人的代码时被证明是有用的。每个人都有自己的......你的例子中的关键部分是不要“重复代码”!

例如:
count = count + 1 // Add to the count <- 坏

此处的演示文稿描述了 how to write good comments .

或者，您可以查看此博客条目 Make the Software Shine: How to Write Good Comments .