Clean Code --第四章

注释
"别给糟糕的代码加注释----重新写吧"

若编程语言足够有表达力,或者我们长于用这些语言来表达意图,就不那么需要注释--也许根本不需要

4.1 注释不能美化糟糕的代码
写注释的常见动机之一是糟糕的代码存在。
4.2 用代码来阐述
4.3 好注释
唯一 真正好的注释是你想办法不去写的注释
4.3.1 法律信息
4.3.2 提供信息的注释
4.3.3 对意图的解释
4.3.4 阐释
注释把某些晦涩难明的参数或返回值的意义翻译为某种可读形式
4.3.5 警示
定期删除没有的TODO
4.3.7 放大
注释可以用来放大某种看来不合理之物的重要性
4.3.8 公共API中的doc
4.4 坏注释
坏注释都是糟糕的代码的支撑或接口,或者对错误决策的修正
4.4.1 喃喃自语
4.4.2 多余的注释
4.4.3 误导性注释
4.4.4 循环式注释
4.4.5 日志式注释
4.4.6 废话注释
4.4.7 可怕的废话
4.4.8 能用函数或不变量时就别用注释
4.4.9 位置标记
4.4.10 括号后面的注释
4.4.11 归属与署名
4.4.12 注释掉的代码
4.4.13 HTML注释
4.4.14 非本地信息
4.4.15 信息过多
4.4.16 不明显的联系
4.4.17 函数头
4.4.18 非公共代码中的javadoc
4.4.19 范例

你可能感兴趣的:(Clean Code --第四章)