【日常积累 - 04】《编写可读代码的艺术》- 写出优雅的代码

雁宇up

于 2021-08-17 22:06:17 发布

阅读量1k

点赞数 3

分类专栏：日常积累

本文链接：https://blog.csdn.net/yanyuxiangtoday/article/details/119767148

版权

最近看了《编写可读代码的艺术》收获颇丰，刚好这本书的读书笔记适合放在这里。程序员的一大乐趣就是可以自己决定创作出的东西，而代码的可读性、代码是否优雅，都决定了你作品的好坏，想要好的作品吗？那就想办法写出更优美的代码吧。

前言

程序员之间的互相尊重和对工作的尊重都体现在代码中。

代码是写给人读的，应该便于理解，优质的代码可以让协作变得高效。

学习编写好代码的习惯，并应用于实践中。

选择专业的词。
避免泛泛的名字。
用具体的名字代替抽象的名字。
使用前缀或者后缀附加更多信息。
- 增加单位。如time_cost_day, time_cost_ms
- 当前数据格式。如i_days，f_days。
- 未处理的变量前面加raw_等
控制名字长度的依据
- 如果变量作用域小，则可以使用较短的名字。如果变量作用域较大，则尽量使用信息完备的名字。
- 采用缩写的原则是：团队新成员能否理解这个命名
利用名字的格式来表达含义
- 可参考Google C++代码风格
- 类名、函数名首单词大写
- 宏全大写
- 变量名全小写，用下划线隔开
- 成员变量最后可以加下划线等，如CountChars_
如果一个flag要用于多个模式选择，那么就拆分flag，给他们不同的命名。

多问自己几遍，这个名字会被别人解读为其他含义吗？
命名尽量具体
用min、max表示包含的极限
用first和last表示闭区间（stop表示右开，last是右闭）
用begin和end表示左闭右开区间
给布尔值命名
- bool read_password = true，不能确定是需要读密码还是已经读取了密码
- bool need_password = true会更好。
- 通常加上is、has、can、should这样的词可以让布尔值更加明确。
命名需要与使用者的期望相匹配
- 如GetMean（），可能是直接获取已经计算好的mean，也可能是循环计算mean。改成ComputeMean会更好。
- 如调用size（）可以改为CountSize（）。

关注