提高代码质量 - 代码整洁之道读书笔记

第一章

什么是整洁代码

1. 没有重复的代码
2. 利于后期维护
3. 高内聚，低耦合
4. 包含尽量少的实体，如类，方法，函数
5. 能通过所有的测试

第二章

类，函数，参数以及目录文件的命名规则(做有意义的命名)

1. 做有意义的区分

以数字命名是依义命名的对立面，如item1，item2…根据参数的含义命名；

不要使用含义相近的函数命名，如getUserInfo，getUser等意义含混的命名；

2. 使用可以读的出来的单词(英语单词不要使用自造词)
3. 使用可搜索的名称(用var声明全局的大写变量)
4. 避免使用编码
5. 避免思维映射(使用读者可懂的命名)
6. 类名

避免使用Data，Info这样没有标志性的名词；

使用名词或名词短语；

尽量简短；

7.方法名

使用动词或动词短语；

依Javabean标准加上set，get，is前缀；

8. 每个概念对应一个词
9. 别用双关语(如add，使用append，insert代替)
10. 添加有意义的语境

firstName,lastName,street改为addrFirstName，addrLastName，addrStreet

11. 不要添加没用的语境

第三章

函数

1. 短小
2. 代码块和缩进
3. 只做一件事
4. 每个函数一个抽象层级（自顶向下读代码，向下规则）
5. switch语句（写在类的继承关系中）
6. 使用描述性的名称
7. 函数参数

标志参数：参数类型为boolean，应该拆成两个函数

二元函数：转换成一元函数处理（写成当前类的成员变量）

参数对象：如果有两个，三个或三个以上的参数，把其中一些参数封装成类

参数列表：向函数传入数量可变的参数（{…args}）

动词与关键字：函数名称以及参数名称的命名

8. 无副作用
9. 错误处理

把try/catch里面的代码块抽象成一个函数。catch/finally后面不应该有任何代码

10. 不要重复自己

第四 五章

注释与格式

1. 尽量少的注释
2. 代码格式：可读性与可维护性
3. 垂直格式：自顶向下的规则，用空白行表示一个独立概念的开始
4. 横向格式：每行代码的长度尽量短小

第六章

对象和数据结构

第七章

错误处理

第八章

边界