clean code 读书笔记（一）

一、命名规则

1. 见名知其意，不要使用magic number
2. 接口和实现，建议接口不要加大写字母I，接口实现后加Impl, 如ShapeFactory(接口), ShapeFactoryImpl(实现)
3. 方法名应当动词或动词短语，如postPayment, deletePage, save。对于重载的构造器，使用描述参数的静态工厂方法名。如：
   Complex fulcrumPoint = Complex.FromRealNumber(23.0)
4. 不要对类名，属性字段添加没有用前缀，可以添加能区分当前字段，类的前缀，如：
   firstName, lastName, street, houseNumber, city, state, zipcode 这些构成了一个地址，其中state不太清楚是什么意思，此时需要加上addrState来表明意思。当然这么多字段，还是将其抽象成Address对象最好。

二、函数

1. 函数体要尽可能的短小，长度不能过长。
2. 每个函数只做一件事情。
3. 函数定义顺序遵循自顶向下的规则。
4. 尽量消除switch语句，若实际情况无法消除，则将switch语句放入到静态工厂中。
5. 函数参数尽可能保持在一个或两个，除非有足够的特殊理由才能用三个参数。
6. 函数参数不能有标识参数，如render(Boolean isSuite) 应拆分成renderForSuite()和renderForSingleTest()
7. 当函数看起来需要两个，三个或三个以上的时候，就说明其中一些参数需要封装成类了。
8. 将指令和询问分开。如:

if (attributeExists("username")) {
    setAttribute("username", "rory")
}

9. 使用异常来代替错误码。
10. 将try catch中业务逻辑代码块抽离成函数。

三、注释

1. 尽量不使用注释来解释代码意图，而是使用代码本身来阐述意图。
2. 值得写的注释：如法律信息，提供信息注释，对意图的解释，warning，TODO，FIXME，说明某些对象的重要性， Java API doc.

四、格式

1. 实体变量应生命在顶部，函数内局部变量应声明尽可能靠近其使用位置。
2. 紧密的代码应紧靠在一次，其余用空行隔开。
3. 相关函数。如一个函数调用另外一个函数，应该将他们放在一起，而且调用者尽可能的放在被调用者的上面。相关性越强，函数间的距离就该越短。