《代码整洁之道》阅读笔记

《代码整洁之道》主要讲述了一系列行之有效的整洁代码操作实践。软件质量，不但依赖于架构及项目管理，而且与代码质量紧密相关。这一点，无论是敏捷开发流派还是传统开发流派，都不得不承认。这本书的阅读对象为一切有志于改善代码质量的程序员，书中介绍的规则均来自作者Bob大叔多年的实践经验，涵盖从命名到重构的多个编程方面，虽为一“家”之言，然诚有可资借鉴的价值。

　

第一章 整洁代码

1. 阅读本书有两种原因： 第一，你是个程序员；第二，你想成为更好的程序员。P1
2. 勒布朗（leBlanc）法则：稍后等于永不。P3
3. 写整洁的代码，需要遵循大量的小技巧，习得“整洁感”或“代码感”。P6
4. “整洁的代码只做一件事”。P7
5. 贝克简单代码规则：P9
   • 能通过所有的测试
   • 没有重复代码
   • 体现系统中的全部设计理念
   • 包括尽量少的实体，比如类、方法、函数等
6. 保持代码整洁。 P12

第二章 有意义的命名

1. 名副其实——如果名称需要注释来补充，那就不算是名副其实。P16
2. 使用读得出来的名称。P19
3. 类名（名称或名称短语）。P23
4. 方法名（动词或动词短语）。P23
5. 同一每个概念对应一个词。P24
6. 添加有意义的语境。P25

第三章 函数

1. 短小（25行）。P32
2. if语句、else语句、while语句内只有一行。P32
3. 只做一件事。P33
4. switch不只做一件事，违反单一职责原则，使用多态重构。P35
5. 使用描述性的名称。P36
6. 函数参数避免超过三个。P37
7. 标识参数标识此函数不止做一件事。P38
8. 如果参数超过三个并且多次成对出现就创建参数对象。P39
9. 无副作用，命令查询分离原则（Command Query Separation）。P42
10. 错误码通常使用枚举类型，数量多之后使用或添加新的错误码很困难，使用异常或之后派生更好。P44
11. 别重复自己，代码臃肿，修改麻烦，许多原则包括面向切面编程和面向组件编程意图消除重复。P44
12. 写代码就像写文章要不断打磨。P45

第四章 注释

1. 无法找到不用注释就能表达的方法，所以总要用注释。P50
2. 用代码的可读性替代注释。P50
3. 注释往往是因为糟糕的代码而存在的。P50
4. 多余的注释。P56
5. 忘更新的误导性注释。P58
6. 日志性注释（有版本控制器就不需要）。P59
7. 归属于署名。P63
8. 注释掉的代码。P63