书籍下载地址 clean code
以下内容为个人阅读时结合自身经历的一些理解,以及对于一些个人认为比较重要的内容的记录
第一章 整洁代码
1.迭代开始前做研发设计时不仅仅考虑新功能如何实现,还需要考虑原来相关的代码是否需要进行重构(前提一定要将原来的逻辑完全理清,否则重构反而会带来很多新的问题)。
2.减少重复,提高表达力。个人工作中一般重复代码出现在为某一业务场景编写方法时,由于考虑的是业务场景,所以觉得该方法不会复用,编写时将逻辑全部集中到了一起。其实可以先写出该场景操作流程,然后从宏观的角度将里面的一些步骤提取出来,便于复用,减少重复,这样做也能让其他没接触过相关业务的同事更好理解代码逻辑。
第二章 有意义的命名
1.变量,方法,类的命名都应该更精确。
同样的代码,仅命名的不同,可读性上却有着极大差别
一个简单的变量命名都可能会影响他人对一段代码的理解,工作中即便是一小段代码逻辑,都可以考虑怎么写可以让可读性更高
2.类名和对象名应该是名词或名词短语,方法名为动词或动词短语
第三章 函数
1.每个函数一个抽象层级,实现能够自顶向下阅读代码,阅读一个函数引出下一层级的函数
2.函数无副作用,即保证函数只做一件事
第四章 注释
1.通过命名,合理设计代码结构等方式减少注释(时间比较长的注释可能存在误导作用)
第五章 格式
第六章 对象和数据结构
第七章 错误处理
第八章 边界
第九章 单元测试
1.注重可读性
2.测试代码分为三步构造-操作-校验(build-operate-check)
3.整洁的测试应该遵循5个原则FIRST
第十章 类
1.类的组织 类首先是公共静态常量,然后是私有静态常量,然后是私有实体变量,在之后是公共函数,涉及到私有函数紧随其后。
2.类尽量短小,应该能用25个单词描述一个类,且不用if,and,or,but等词汇