Question

正如我们在前一章中提到的，很多时候注释的作用就是要告诉读者当你写代码时你是怎么想的。遗憾的是，很多注释只描述代码字面上的意思，没有包含多少新信息。

下面的例子就是一条这样的注释：

这里的注释只是描述了它下面的那行代码。相反，更好的注释可以是这样的：

这条注释从更高的层次解释了这段程序在做什么。这更符合程序员写这段代码时的想法。

有趣的是，这段程序中有一个bug！函数CompareProductByPrice（例子中没有给出）已经把高价的项目排在了前面。这段代码所做的事情与作者的意图相反。

这是第二种注释更好的原因。除了这个bug，第一条注释从技术上讲是正确的（循环进行的确是反向遍历）。但是有了第二条注释，读者更可能会注意到作者的意图（先显示高价项目）与代码实际所做的有冲突。其效果是，这条注释扮演了冗余检查的角色。

最终来讲，最好的冗余检查是单元测试（参见第14章）。但是在你的程序中写这种解释意图的注释仍是值得的。