知一的指纹

《编写可读代码的艺术》读书笔记

版权声明: 本文为博主原创文章,发表自 知一的指纹。转载需向 我的邮箱 申请。

优雅的代码注释

准确描述代码的行为。
代码分块,描述每一块的行为。

合理的变量命名

使用更具像化的词语描述,使别人不会误解。
对于返回是否的变量命名通过『is_』做前缀。

简化循环流程

条件语句中将常量放表达式右边。
避免使用 三目运算符、do/while 、goto 这些可读性比较差的结构。
把超长的表达式拆分成更容易理解的小块。
复杂表达式的等价转换写法,使可读性更高(德摩根定理)。
减少中间变量,减少中间变量的作用域。
积极的发现并抽取出不相关的子逻辑,是不是可以提取到公共方法或更高层;同时也要避免过度的拆分公共方法。
一次只做一件事,将你要做的事分成若干子步骤去处理。
『如果你不能把一件事解释给你祖母听的话说明你还没有真正理解它。』 —— 阿尔伯特 爱因斯坦

少写代码

一定程度上代码库越小越好,越轻量越好,这样你维护的成本会越小,主要是不要过度理解需求,以最方便的方式去解决问题,不要过度设计,因为你有时候很难去用到这些。
删除一些没用的代码。
熟悉你周边的库,每隔一段时间,花十几分钟来阅读标准库中的所有函数/模块/类型的名字。

测试的可读性

封装不重要的细节,使测试的重要细节更突出。
让错误消息具有可读性,将错误的输出打印出来。
合理的测试函数命名。
不要着迷于100%的测试覆盖率,参考2/8法则。
不要让测试成为产品开发的障碍。

总结

大概看了两周左右,将一些觉得比较好的内容总结了一下,并在实际工作中应用起来,之前一些不好的习惯在慢慢的刻意改正。书是本好书,经验与实例相结合,更容易读懂其中含义,让人品味到了坏代码的味道。这本书的内容还需要不断思考并实践。借用前辈告诫的一句话结尾『不要放任自己,要时刻保持严谨的态度,对代码负责,也是对自己负责。』


如果此文章能给您带来小小的提升,不妨小额赞赏我一下,以鼓励我写出更好的文章!
Noogel's WeChat Pay

微信打赏

Noogel's Alipay

支付宝打赏