第4章 注释
若编程语言足够有表达力，或者我们擅长用这些语言来表达意图，就不那么需要注释——也许根本不需要。
注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。
代码在变动，在演化，程序员不能坚持维护注释，注释并不总是随之变动。
不准确的注释要比没注释坏得多。
只有代码能忠实地告诉你它做的事。那是唯一真正准确的信息来源。
注释不能美化糟糕的代码。尽量用代码来阐释意图而不是注释。
唯一真正好的注释是你想办法不去写的注释。
有时，注释把某些晦涩难明的参数或返回值的意义翻译为某种可读形式，也会是有用的。
有时，用于警告其他程序员会出现某种后果的注释也是有用的。
注释可以用来放大某种看来不合理之物的重要性。
没有什么比被良好描述的公共API更有用和令人满意的了。
怀注释都是糟糕的代码的支撑或借口，或者对错误决策的修正，基本上等于程序员自说自话。
如果你决定写注释，就要花必要的时间确保写出最好的注释。
程序员的挫败感可以由改进代码结构而消除。
用整理代码的决心来代替创造废话的冲动吧。你会发现自己成为更优秀、更快乐的程序员。
能用函数或变量时就别用注释。
假如你一定要写注释，请确保它描述了离它最近的代码。
别在注释中添加过多或无关的细节描述。
注释及其描述的代码之间的联系应该显而易见。
为只做一件事的短函数选个好名字，通常要比写函数头注释要好。