一、为什么要整洁代码
首先代码呈现了需求的细节,在某些层面上无法被抽象和忽略,所以代码会一直跟随我们。
为什么要整洁代码?如果我们不要整洁代码,会出现哪些问题:
(一)生产力低:当代码很混乱的时候,生产力是会下降。(做项目)
(二)维护:当代码混乱是很难去维护,自己无法理清,别人看不懂。当问题爆发以后无法去管理代码,而其他人也无法解决话优化代码。
(三)态度:混乱的代码归根结底反映出了我们对于代码的不在意。
根绝以上出现的问题,我们要整洁代码。
二、什么是整洁代码
细节(内存泄露、前后不一致的命名、竞态条件代码)、只做好一件事(意图坚定,目标明确)(比如有一个函数函数名是验证用户,但是里头却有注销session。这样有的人使用这个函数就会导致错误)、简洁(在书写代码的时候应该尽可能的干净利落,讲究事实,不引人猜忌,让人明白自己的意图。)不要有重复代码
三、怎样做到整洁代码
命名
(一)命名时应该根据具体含义、功能去命名。可以说名字已经让不了解函数变量和类的人知道,你这个的功能是什么。避免代码的模糊。
(二)尽量不使用关键字。比如LIST(代表一组)。这个就不要使用了。字母I(大写),小写(l),大小写(o)
(三)对于名字,应该慎重一些,不要为了避免重名,随便起名字。比如什么a1,a2,a3……
(四)名字应该起的能够读出来。
(五)名称长度应该与其作用域大小相对应。比如短方法的本地变量可以使用单字母,但是如果这个变量代码多个地方使用内么应该根据其所代表的功能和含义起名。这样既可以方便理解也便于搜索。
(六)尽可能不要使用前缀去标识成员变量,应该将类和函数做的足够小。
(七)接口和实现
(八)类名和对象名:名词和名词短语,方法名:动词和动词短语
(九)每个概念对应一个词,比如控制层:controller。而且不要一个词代表不同含义。add:增加或连接两个现存值来获得新值。add将参数加入到集合。
(十)1:计算机领域或者根据项目的领域起名字。2:起的名字尽量符合语境。
函数:函数越短小、功能越集中、就越能起个好名字
(一)函数应该短小
(二)函数应该做一件事,做好一件事。
(三)每个函数一个抽象级
(四)函数参数优先顺序,没有、一个……应避免三个。可以试试类里的私有变量。参数太多,对测试不太友好,因为参数太多,测试覆盖多有可能值的组合太多。(?)
1、一元函数的普遍形式:传入单个参数一般有两种理由:1操作该函数,将其转换为其他什么东西,再输出。有输入参数,有输出参数2:表示事件。有输入参数而没有输出参数。比如:使用该参数修改系统状态。另外,参数和函数名最好形成一种联系。比如writeField(name),name这个将被write
2、二元参数的普遍形式:尽量编写长一元函数。
(五)抽离try/catch代码块。最好把try和catch代码块的主体部分抽离出来另外形成函数
小结:
单元测试,分解函数、修改名称、消除重复、缩短和重新安置方法,还可以拆解类。
感悟:
起名字的重要性
try/catch