作者：通爸

《编写可读代码的艺术》是与Clean Code相似的书，提供改善“丑陋”代码的技巧。本书193页，共16章内容。

图书封面

本书分为四个部分：

表面层次的改进-命名/注释以及审美
简化循环和逻辑
重新组织代码
精选话题

关键思想：代码应当易于理解

可读性基本定律：代码的写法应当使别人理解他所需的时间最小化。

1 表面层次的改进

包括好的名字，好的注释，还有好的格式

1.1 把信息装进名字里

1.1.1 选择专业的词

反例：函数名 GetPage(url)
正例： FetchPage()、DownloadPage()
反例： class BinaryTree的方法Size() VS
正例：Hight() NumberNodes(),MemoryBytes()
反例： class Thread的方法Stop()
正例： Kill() Pause(),Resume()

1.1.2 避免泛泛的名字

关键思想：清新和准确比装可爱好
迭代器变量，应该有明确指向

选择更有表现力的词

避免tmp和retcode泛泛的名字
retcode建议：retcode没有包含更新信息。描述该变量的值的名字代替它。

retcode改为sum_squares
tmp建议：tmp这个名字只应用于短期存在且临时性为其主要存在因素的变量。

tmp改为user_info
如果需要使用tmp，也需要指明tmp_file，或者tmp_data.
迭代器变量，应该有明确指向

i,j,k改为clubls_i/ci,members_i/mi,users_i/ui

1.1.3 用具体的名字代替抽象的名字

名字更具体而不是抽象
反例：函数ServerCanStart：检测服务是否可以监听某个端口
正例： CanListenOnPort()

DISALLOW_COPY_AND_ASSIGN更好

1.1.4 给名字附带更多的信息

1、一个变量名就是一个小小的注释
反例：string id ； //example:”0x128a232b”
正例：string hex_id;
2、变量名带单位

带单位的值
3、附带额外信息

附带额外信息

1.1.5 决定名字的长度

名字隐含约束就是不能太长。

1、在小的作用域可以使用短名字。
2、输入长名字不再是问题。【内置补全功能】
3、首字母缩写词和缩写
经验原则：团队新成员可以理解这个名字含义。
4、丢掉没用的词
反例：ConvertToString()
正例： ToString()

1.1.6 利用名字的格式表达含义

利用下划线，大小写或者连字符可以装载更多含义。 在google的C++代码规范中：

kMaxOpenFiles表示常量，MAX_OPEN_FILES表示宏
state是局部变量，state_是成员变量

1.1.7 小结

1. 使用专业的单词
1. 避免空泛的名字
1. 使用具体的名字描述细致的事物
1. 给名字带上重要的细节
1. 给作用域更大的名字采用更长的名字
1. 有目的使用大小写和下划线

1.2 不起误解的名字

关键思想：要多问自己几遍，“这个名字会被别人误解成其他含义吗？“要仔细审视这个名字

反例： Filter(“years <= 2010”) 挑出还是减掉？
反例： Clip(text，length)是截断到，还是去掉？
正例：使用min和max表示极限
正例：使用first和last表示包含的范围
正例：使用begin和end表示包含/排除的范围

布尔型命名
正例：加上is，should，has，can，use变得含义更明确
正例：避免使用反义名词：bool disable_ssl=false;

1.3 审美

布局的三个原则：

使用一致的布局，让读者很快习惯这种风格。

让相似代码看上去相似。

相关的代码分组，形成代码块。

审美

1、使用【从审美角度】让人愉悦的代码更容易
2、安排换行是节奏保持一致和紧凑
3、用方法规整不一致的东西
正例
4、在需要时，使用列对齐
使用列对齐
5、选择有意义的顺序，并保持一致
6、把申明按照块组织起来
7、把代码分成段落
8、一致性比”正确“风格更重要

1.4 注释

关键思想：注释的目的就是尽量帮读者和作者了解一样多

注释
1、什么不需要注释

不要为那些可以从代码快速推断的事实写注释
不要为了注释而注释
不要为不好的名字加注释，应该把名字改好

2、记录你的思想

加入“导演评论”
为代码的瑕疵做注释（//TODO:）流行的标注
给常量加注释
常量本身不需要解释，记录决定这个常量取值的想法，便于后续优化。
3、站在读者的角度

意料之中的提问
公布可能的陷阱
全局性的注释
高级别的注释信息，包括文件，类，模块如何组织工作的。
用注释来总结代码块，防止迷失细节

1.5 写出言简意骇的注释

言简意骇

关键思想：注释应该有很高的信息/空间率

1、让注释保持紧凑
正例
2、避免使用不明确的代词（it，this）
3、润色粗糙的句子
4、精确描述函数的行为
正例
5、用输入/输出的例子来说明情况
6、申明代码的意图
【4，5，6用单元测试代替注释更妥】
7、具名函数参数的注释
使用嵌入式的注释，例如Function(/arg=/…)来解释函数的参数。
8、采用信息量高的词，使得注释简洁

2 简化循环和逻辑

2.1 把控制流变得易懂

关键思想：把条件，循环以及其它对控制流的改变做的越“自然”越好。运用一种方式使得读者不用停下来重读你的代码

1、条件语句中参数顺序
if(length<=10) 还是 if(10>=length)?
while(bytes_expected < bytes_recieved) 还是 while(bytes_expected > bytes_recieved) ?
指导原则【和语言的语法一直】

比较的左侧	比较的右侧
被询问的表达式，它的值倾向于不断变化	用来作比较的表达式，它的值倾向于常量

if(object == null) 还是 if(null == object)?

2、if/else语句块的顺序
if条件选择标准：
先处理正逻辑而不是负逻辑
先处理简单的
先处理有趣或者可疑的
3、三目运算符
关键思想：相对于追求代码最小行，一个更好的方式就是最小化人们理解他所需的时间
建议：默认情况下都if/else, 三目表达式只在最简单的情况下使用。
4、避免do/while循环
使用while/for，而不是for/while, 把条件【危险】放到首先看到地方。