13.8 小结

注释的目的是确保系统的结构和行为对读者来说是显而易见的，所以他们可以快速找到他们需要的信息，对系统进行修改，并确信能够奏效。其中一些信息可以在代码中以一种对读者来说已经很明显的方式表示，但有大量的信息不容易从代码中推导出来。注释补充了这些信息。

当遵循“注释应该描述那些在代码中不明显的东西”这一规则时，“明显”是从第一次阅读你的代码的人（而不是你）的角度来看的。在写注释时，试着把自己放在读者的心态上，问自己他或她需要知道的关键事情是什么。如果你的代码正在接受审查，而审查员告诉你有些东西不明显，不要和他们争论；如果读者认为不明显，那么它就不明显。与其争论，不如试着理解他们感到困惑的东西，看看你是否可以用更好的注释或更好的代码来阐明。