代码整洁之道-函数

可口可乐嗨 可口可乐嗨     2022-12-26     620

关键词:

函数

参考书籍:《代码整洁之道》,语言:Python

1.函数要短小

1)每个函数只做一件事,并且每个函数都依次把你带到下一个函数,这就是函数应该达到的短小程度。

2)if, else, while等语句的代码块应该只有一行,该行大概是一个函数的调用(具有说明性的函数名称会增加代码的可读性)

3)编写函数是为了把一个大的概念(函数名)拆分成另一个抽象层级上的一系列步骤

4)判断函数是否只做了一件事? > 看其能否再拆出一个函数,并且拆出的函数不能只是单纯的重新诠释其实现

 

2.给函数取个描述性的名称

1)给函数取一个能说明其功能的名称,长而具有描述性的名称比短而令人费解的名称好

2)命名方式要保持一致,使用与模块名一脉相承的短语、名词、动词来给函数命名

 

3.每个函数就是一个抽象层级

1)现象:函数中混杂着不同的抽象层级让读者无法判断某个表达式是基础概念还是细节

2)建议:用自顶向下规则,尽量让每个函数后面都跟着位于下一个抽象层级的函数

  (程序像一系列to起头的段落,描述当前的层级函数,并引用位于下一层级的函数)

 

4.分割指令与询问

将函数做了什么事和回答了什么事分开,如果两者都做,则容易引起混乱

 

5.消除重复代码

重复的代码会导致代码臃肿,不利于维护。比如,当需要修改一段逻辑时,可能需要修改多个位置

 

前端阅读——《代码整洁之道》摘记之整洁代码命名函数注释

 这本书提出一种观念:代码质量与其整洁度成正比。干净的代码,既在质量上较为可靠,也为后期维护、升级奠定了良好基础。(作者认为书可以有另一个名字:《如何在意代码》)读这本书,促使我思考代码中何谓正确,... 查看详情

代码整洁之道——2函数

一、函数参数(两个或者更少)限制函数的参数至关重要,因为这样测试函数会更简单。有超过三个以上的参数,测试的时候就要使用不同参数测无数的场景。一个或者两个参数是理想情况。如果可能的话避免三个参数。三个以... 查看详情

代码整洁之道——4类

一、优先使用ES6语法的类而不是ES5的纯函数传统的ES5类语法很难拥有类的继承、构造函数和方法的定义。如果你需要使用继承(要注意的是,你可能不需要),那么就用ES2015/ES6的类。但是,在你发现你需要更大更复杂的对象的... 查看详情

代码整洁之道

...释不如无注释,不能保证注释新鲜,删除注释。四、格式代码排版上下有间隙代码 查看详情

php开发-代码整洁之道(代码片段)

CleanCodePHP目录介绍变量使用见字知意的变量名同一个实体要用相同的变量名使用便于搜索的名称(part1)使用便于搜索的名称(part2)使用自解释型变量避免深层嵌套,尽早返回(part1)避免深层嵌套,尽早返回(part2)少用无意义的变量名... 查看详情

php开发-代码整洁之道(代码片段)

CleanCodePHP目录介绍变量使用见字知意的变量名同一个实体要用相同的变量名使用便于搜索的名称(part1)使用便于搜索的名称(part2)使用自解释型变量避免深层嵌套,尽早返回(part1)避免深层嵌套,尽早返回(part2)少用无意义的变量名... 查看详情

代码整洁之道(代码片段)

...可见命名。我们给变量、函数、参数、类和封包命名、源代码文件命名、目录命名,良好的命名规范使得代码以及工程的维护难度大大降低,下面列出良好命名的几条简单规则。1.名副其实变量、函数或类的名称应该已经... 查看详情

c#代码整洁之道读后总结与感想

1. 基本信息C#代码整洁之道:代码重构与性能提升 ,英文名为CleanCodeinC#。作者:[英]詹森·奥尔斯(JasonAlls)著,刘夏译机械工业出版社,2022年4月出版。1.1. 读薄率书籍总字数489000字,笔记总字数8927字。读薄率8927÷48... 查看详情

《代码整洁之道》

代码整洁之道代码猴子(CodeMonkey):低水平编码者.童子军规.技艺(craftsmanship):知和行.学写整洁代码,掌握原则和模式,并付出行动.整洁代码代码呈现了需求的细节.这些细节无法被忽略或抽象,必须要严谨,精确,规范和详细.糟糕的代码... 查看详情

第五次读书笔记——robrtc.martin的《代码整洁之道》

 本周我读的书是美国作者RobrtC.Martin的《代码整洁之道》。一周的时间,我主要阅读了本书的前五章,关于整洁代码、有意义的命名、函数、注释以及格式等内容。书中作者有个观点:优雅和高效。作者说:代码逻辑应当直... 查看详情

整洁之道如何写出更整洁的代码(上)

 如何写出更整洁的代码    代码整洁之道不是银弹,不会立竿见影的带来收益。  没有任何犀利的武功招式,只有一些我个人异常推崇的代码整洁之道的内功心法。它不会直接有效的提高你写代码的能力与速度,... 查看详情

typescript代码整洁之道

干净整洁的代码,不但质量更可靠,也为后期升级、维护打下了良好的基础。那么,整洁代码的衡量标准是什么?本文将RobertC.Martin的CleanCode思想融入到TypeScript,一起探讨研究代码整洁之道。 WTFs/Minute 1.命名的艺术计算... 查看详情

读《代码整洁之道》-函数名称应该表达其行为(代码片段)

...码的”,让我非常吃惊。我一直也是认为,好的代码应该是看到函数名就应该知道含义,看到参数和返回值就应该可以放心使用,而不是非要去读源码才不会误用。今天重读《代码整洁之道》,看到书中提到&#... 查看详情

代码整洁之道读书笔记

代码整洁之道 前言如何用功 阅读大量代码 找优点和缺点第一章整洁代码不要留到以后,稍后等于永不烂代码影响生产力代码整洁性不但有关效率,还有关生存好代码 C++之父  尽量减少依赖关系,便于维护... 查看详情

代码整洁之道

文章目录代码整洁之道定义变量名字的时候常用的单词有意义的命名怎样写简洁的,别人一眼可以看的懂的方法方法参数越少越好注释格式别给方法返回null值我们该提炼方法中的变量还是不提炼方法中的变量?代码整洁之道定... 查看详情

代码整洁之道读书笔记

代码整洁之道TableofContents1.原则1.1.单一权责1.1.1.一个类应该完成一个类型的任务1.1.2.內聚性要高,即每个函数使用类变量的多少1.2.开放封闭原则1.2.1.对内封闭对外开放2.军规2.1.只做好一件事2.2.短小精悍2.3.代码不要重复2.4.开... 查看详情

代码整洁之道读书笔记

代码整洁之道TableofContents1.原则1.1.单一权责1.1.1.一个类应该完成一个类型的任务1.1.2.內聚性要高,即每个函数使用类变量的多少1.2.开放封闭原则1.2.1.对内封闭对外开放2.军规2.1.只做好一件事2.2.短小精悍2.3.代码不要重复2.4.开... 查看详情

代码整洁之道——8错误处理

抛出错误是一个很好的事情。这意味着当你的程序出错的时候可以成功的知道,并且通过停止当前堆栈上的函数来让你知道,在node中会杀掉进程,并在控制套上告诉你堆栈跟踪信息。一、不要忽略捕获的错误不处理错误不会给... 查看详情