代码整洁之道学习笔记
代码整洁之道学习笔记
一、整洁代码
整洁的代码只做好一件事
好的代码：
- 能通过所有的测试
- 没有重复代码
- 体现系统中的全部设计理念
- 包含尽量少的实体，比如类、方法、函数等。
时时保持代码整洁：每次签入时，代码都比签出时简洁。
二、有意义的命名
注意命名，一旦发现有更好的名称就换掉旧的。
变量、函数或类的名称应该已经答复了所有的大问题，为什么存在，做什么事，应该怎么用。
- 名副其实
- 避免误导
- 做有意义的区分
- 使用读得出来的名称
- 使用可搜索的名称
- 每个概念对应一个词
- 不要添加没用的语境，比如统一的前缀什么的。
三、函数
- 短小
- 只做一件事，原则是：能拆分就拆分
- 每个函数一个抽象层级
- 将switch语句埋在抽象工厂下
- 使用描述性的名称
- 函数参数尽可能少，尽可能不要传递 (boolean isSuite)这种标识参数，它表示函数根据布尔值做不止一件事。
- 无副作用（其实还是指只做一件事）。
- 分割指令与询问，if(set(xx,xx))这种形式很不好。
- 使用异常替代返回错误码
- 把try catch分离出单独的函数
4、注释
- 好的注释
- 解释意图
- 翻译参数或返回值
- 警示
- TODO
- 放大重要性
- JavaDoc