第四章 注释

核心观念

注释是一种必须的恶。注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败

• 注释会撒谎。

程序存在的时间越久，注释的可信度、可读程序就很低。作者认为，程序员虽然有保持注释精读的责任，但是更应该做的是整理代码，减少注释，注释过多往往是一种程序“腐化的坏味道”。

• 注释不能美化糟糕的代码。

好的注释

不可省略的涉及到法律的信息 豹：比如开源协议。

提供信息的注释

对意图进行解释 豹：对某些可以选择的实现决定进行解释。

警示 豹：这里指的是一些特定行为的代码的注释。比如某个测试可能会运行很长时间之类的注释。

...

坏的注释

喃喃自语： 这种情况大量存在，属于程序员的只说自话，基本是垃圾代码的借口或者错误决策的修正。

多余的注释 ： 大量存在，没有什么意义的废话注释。

误导性注释 ：不够精确或者干脆写错了

循规试注释 ：指的是应文档化工具的需求就添加的本来不需要注释的注释。

日志试注释 ：指的是本代码文件的修改历史类，将每天的修改记录写上，这完全没有必要，可以被现代源码管理工具取代。它影响了代码阅读。

废话注释

能用函数或者变量的时候就不用注释