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

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

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、简单设计规则:

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342

推荐阅读更多精彩内容

  • 代码整洁之道 Clean Code 第一章 整洁代码 代码的重要性我们永远抛不掉代码,因为代码呈现了需求的细节。在...
    Pengzh1阅读 1,195评论 0 1
  • 一、整洁代码 A.混乱的代价 1.有些团队在项目初期进展迅速,但有那么一两年的时间却慢去蜗行。对代码的每次修改都影...
    ZyBlog阅读 2,014评论 0 2
  • 目录及笔记链接 序 丹麦谚语:小处诚实非小事。 建筑师路德维希:神在细节之中。 日本的 5S 哲学: 整理(整理、...
    小镭Ra阅读 1,495评论 3 3
  • “相对于任何宏伟景愿,对细节的关注甚至是更为关键的专业性基础。首先,开发者通过小型实践获得可用于大型实践的技能和信...
    寻海阅读 4,706评论 1 27
  • 这边吴月娘家里也是乱糟糟,来昭去世,一丈青夫妇带着儿子嫁人离开。来兴守门,他媳妇也得病去世,来兴偷偷和奶妈如意儿私...
    monkings阅读 5,133评论 0 0