代码整洁之道Clean Code 读后感After Reading

时间:2022-01-05 15:02:27

1.有意义的命名
  名副其实,避免误导
  做有意义的区分,简单明了
2.函数
  短小,职责单一
  别重复自己
3.注释
  用代码来阐述
  可怕的废话
4.格式
  垂直格式,垂直距离,空范围
  横向格式,水平对齐,缩进
5.错误处理
  使用异常而非返回码
  先写Try-Catch-Finally语句
  别返回null值,别传递null值
6.单元测试
  TDD三定律
    在编写不能通过的单元测试前,不可编写生成代码
    只可编写刚好无法通过的单元测试,不能编译也算不通过
    只可编写刚好足以通过当前失败测试的生成代码
  保持测试整洁
  每个测试一个断言
  FIRST(快速Fast,独立Independent,可重复Repeatable,自足验证Self-Validating,及时Timely)
7.类
  类应该短小
  单一权责原则
  内聚
8.系统
  将系统的构造与使用分开:分解,工厂,依赖注入
  扩容
9.迭进
  运行所有测试
  重构,不可重复
  表达力,尽可能少的类和方法
10.逐步改进,坏代码的味道
  注释:准确,简明,代码自描述
  尽可能使用标准命名法
  无歧义的名称
  测试覆盖率,快速而有效
  测试边界条件,全面测试相近的缺陷

注:
  每行代码长度建议不要超过120个字符;
  代码格式整洁,垂直水平对齐;
  注释了的代码段尽量清除掉;
  不准确的注释或者命名等尽量修改或者删除;
  注释尽量少,如果有尽量准确不冗余;
  函数参数尽量少,职责单一;
  不同业务逻辑代码段之间分隔开;
  清除魔鬼数字;
  清除返回null 传递null函数