读《编写可读代码的艺术》

编程需要看了这本书，表达的意思虽然可以get到，但翻译让我没有一口气看完，而是断断续续看的，记下了我认为重要的点，以后也会经常看这篇来重构代码。（来自笔者的小吐槽）

第1章 代码应当易于理解

• 代码的写法应当使别人理解它所需的时间最小化

第一部分 表面层次的改进

第2章 把信息装到名字里

• 使用专业的单词
• 避免空泛的名字
• 使用具体的名字来更细致地描述事物
• 给变量名带上重要的细节
• 为作用域大的名字采用更长的名字
• 有目的地使用大小写、下划线等

第3章 不会误解的名字

• 避免使用多义性的单词（如filter、length和limit）
• 定义一个值的上限或下限时，max_和min_是很好的前缀
• 对于包含的范围，first和last是好的选择
• 对于包含／排除范围，begin和end是最好的选择

第4章 审美

• 重新安排换行来保持一致和紧凑
• 如果多个代码块做相似的事情，尝试让它们有同样的风格
• 把代码按“列”对齐可以让代码更容易浏览
• 用空行来把大块代码分成逻辑上的“段落”

第5章 该写什么样的注释

• 能从代码本身中迅速推断出的事实不需要注释
• 在这些地方记录下想法（指导性批注，代码中的缺陷，常量为什么是这个值）

第二部分 简化循环和逻辑

第7章 把控制流变得易读

• 比较的左侧值更倾向于不断变化， 右侧值更倾向于常量
• if/else语句先处理正确的／简单的情况
• 不要使用do/while循环和goto

第8章 拆分超长的表达式

• 德摩根定理
  • not(a or b or c) <=> (not a) and (not b) and (not c)
  • not(a and b and c) <=> (not a) or (not b) or (not c)

第9章 变量与可读性

• 减少“中间结果”变量
• 减少每个变量的作用域
• 只写一次的变量最好

第三部分 重新组织代码

第10章 抽取不相关的子问题

• 代码库常常有个专门的目录来存放通用代码（比如util）

第11章 一次只做一件事

• 一次只做一件事的流程
  1. 列出代码所做的所有“任务”，“任务”可以小得如“确保这个对象有效”，或者含糊得如“遍历树中所有节点”
  2. 尽量把这件任务拆分到不同的函数中，或者至少是代码中不同的段落中。

第12章 把想法变成代码

• 用自然语言描述程序然后用这个描述来帮助你写出更自然的代码

第13章 少写代码

• 从项目中消除不必要的功能，不要过度设计
• 重新考虑需求，解决版本最简单的问题，只要能完成工作就行
• 经常性地通读标准库的整个API，保持对它们的熟悉程度

第四部分 精选话题

第14章 测试与可读性

• 最好每个测试的输入／输出可以用一行代码来描述
• 若测试失败，错误消息应该能让编写代码者容易跟踪并修正这个bug