美文网首页PHP经验分享
《代码整洁之道 Clean Code》知识整理

《代码整洁之道 Clean Code》知识整理

作者: PHP程序媛 | 来源:发表于2019-08-20 14:34 被阅读4次

第一章 整洁代码(时时保持代码整洁)

1、简单代码规则:

能通过所有测试

没有重复代码

体现系统中的全部设计理念

包括尽量少的实体,比如类、方法、函数等

第二章 有意义的命名

1、名副其实,可以增加代码的可读性(名称需要注释来补充,就不算是名副其实。)

2、避免使用与本意相悖的词

3、做有意义的区分(如以数字系列命名:a1,a2,...),这样的命名并没有提供正确的信息,要以读者能鉴别不同之处的方式来区分(废话是另一种没意义的区分)

4、使用可搜索的名称:尽量避免在代码中出现魔术数字

5、类名和对象名应该是名词或名词短语,方法名应该是动词或动词短语

第三章 函数

1、函数的第一规则是要短小,第二条规则是还要更短小(经验之谈)

原则:函数应该做一件事,做好这件事。只做这一件事。(Service中)

要判断函数是否不止做了一件事,就是看是否能再拆出一个函数且该函数不仅仅只是单纯地重新诠释其实现。

2、使用描述性的名称:不要害怕长名称,长而具有描述性的名称,要比短而令人费解的名称好。

3、函数参数:最理想的参数数量是零(零参数函数),其次是一(单参数函数),再次是二(双参数函数),应尽量避免三(三参数函数or多参数函数),(可读性和测试覆盖率高)

4、标识参数(极不推荐true or false),这说明该函数不止做了一件事。

5、如果函数看来需要两个、三个或三个以上参数,就说明其中一些参数应该封装为类了如:

Circle makeCircle(double x, double y, double radius);

Circle makeCircle(Point center, double radius);

6、使用异常替代返回错误码(抛出错误,捕捉)

7、每个代码块都应该有一个入口,一个出口(即每个函数中只该有一个return语句

第四章 注释

1、好注释是必须的(真正好的注释是你想办法不去写的注释)

第五章 格式

1、概念间垂直方向上的区隔: 在声明,每个函数之间用空白行隔开(参考psr文档 https://www.php-fig.org, https://psr.phphub.org/)

2、垂直方向上的靠近:紧密相关的代码应该相互靠近

3、尽量保持代码行短

4、缩进 

5、团队规则:一组开发者应当采用一种格式风格

一次提交只干一件事

第九章  单元测试

1.TDD三定律

定律一  在编写不能通过的单元测试前,不可编写生产代码

定律二  只可编写刚好无法通过的单元测试,不能编译也算不通过

定律三  只可编写刚好足以通过当前失败测试的生产代码

2.保持整洁测试:测试代码和生产代码一样重要

3、整洁的测试:可读性

每个测试都应该清晰的拆分为三个环节:构造测试数据,操作测试数据,检验操作是否得到期望的结果

4、每个单元测试中的断言数量应该最小化

5、F.I.R.S.T

快速(Fast),独立(Independent),可重复(Repeatable),自足验证(Self-Validating),及时(Timely)

第十章 类

1、类应该短小:通过权责(responsibility)来衡量

单一权责原则,内聚,依赖倒置原则

第12章 迭进

1、简单设计规则:

运行所有测试;不可重复;表达了程序员的意图;尽可能减少类和方法的数量

相关文章

网友评论

    本文标题:《代码整洁之道 Clean Code》知识整理

    本文链接:https://www.haomeiwen.com/subject/bglpsctx.html