首页 > 代码库 > 代码整洁之道读后感(三)

代码整洁之道读后感(三)

注释

  1. 注释不能美化糟糕的代码
  2. 用代码来阐述你的思路
  3. 好的注释是什么?
    1. 法律信息
    2. 提供信息的注释
    3. 对意图的解释
    4. 警示:例如 // Don‘t run unless you have some time  to kill
    5. TODO注释
    6. 公共API的JavaDoc
  4. 坏的注释是什么?
    1. 多余的注释
    2. 误导性的注释
    3. 循轨式注释:所谓每个函数都要有JavaDoc活每个变量都要有注释的规矩简直是愚蠢。这类注释只会让代码混乱不堪。
    4. 日志式注释
    5. 废话式注释: Default Constructor
    6. 信息过多:别再注释里什么都写,把细节描述都写出来。。。my God。

错误处理

  1. 尽量使用不可控异常
  2. 给出异常发生的环境说明
  3. 别返回Null值
  4. 别传递NUll值