注释是在代码表达意图时遭遇的失败。 注释不能美化糟糕的代码 用代码来阐述 好注释 法律信息对基本信息的注释对意图的解释阐释警示TODO注释,程序员认为应该去做,但是由于一些原因没用实现完的注释。放大不合理之物的重要性公共API描述 坏注释 喃喃自语/废话注释多余的注释误导性注释循规式注释:不需要给每一个函数进行注释日志式注释能用函数和变量时就别用注释用于位置标识的注释注释的代码信息过多不明显的联系