1. DRY: 不要重复你自己(Don’t repeat yourself)
DRY是一条最容易理解但又是相对比较难以应用的原则。它是指当你在两处或者更多的地方发现相似代码时,我们应当把它们抽象成一个新的函数,在之前重复的地方调用新的函数并带上适当的参数。
DRY也许是最普遍的一条编程原则,我从未发现一个开发人员认为编写重复的代码是件好事。但是我发现一些开发人员在编写单元测试时忘记了这条原则,例
如:设想一下你改变了一个类的接口,之前已经为这个类编写了很多的单元测试,如果你没有应用DRY原则,这时你需要手动去修改所有使用这个类接口的调用,
来与每一个测试实例的新签名匹配。
2. 编写短小的函数/方法
有三个非常好的理由,选择编写短小的函数。
- 1. 代码会更容易阅读。
- 2. 代码会更容易重用(短小的函数更容易产生松耦合)。
- 3. 代码会更易于测试。
编者注:松耦合:在软件领域中,“耦合”一般指软件组件之间的依赖程度。耦合度松的软件会有较好的扩展性。
3. 给类、函数和变量使用好的命名
直接使用其他开发者的代码而不需要阅读说明文档,没有什么比这更好的事情了,因为代码中的类名、函数名已经能够告诉我们所有需要的信息。所以,采用这种方法,每次在为你的代码中任何元素进行命名的之前请花上几秒钟(思考),这会让大家的生活变得更轻松。
4. 为每个类分配正确的职责
一个类只承担一个职责(单一权责),听起来和有些人知道的SOLID原则很相似,但是这里不是指任意的职责,而是正确的职责。所以,如果我们要设计一个顾客类,我们不会给它创建一个销售的行为,我们只会让它处理所有与一个客户相关的数据。
编者注:SOLID:面向对象设计的五项原则 (是SRP单一职责原则、OCP开闭原则、LSP李式代换原则、ISP依赖反转原则和 DIP接口分离原则,首字符的缩写)。
5. 保持代码的条理性
代码条理性分两个层次
- 物理上的条理性:无论你采用了哪种结构,包、命名空间、文件夹等等,用一种更容易并且凭直觉就能找到代码存放在哪里的方式来组织你编写的类。
- 逻辑上的条理性:不论逻辑上从属关系如何,(只要有逻辑从属关系)类都应该能够互相访问彼此的成员变量,但是如果从属于不同的逻辑结构就应当只能通过接口来访问。这种逻辑分组通常会被实现成(逻辑)层、服务等。
6. 编写很多的单元测试
测试越多越好,它们是所有代码变动的安全保证,我们会在将来的某一天需要运行这些测试代码。
7. 尽早且经常地重构代码(Refactor often and sooner)
软件开发是一个持续发现的过程,为了编写保持与新增/改变的需求匹配的高质量代码,随着开发的进行,重构代码是必不可少的。由于重构是一项带有风险的任务,需要有两个主要的前提条件,来避免由于重构给系统引入新的错误。
- 1. 编写很多的单元测试
- 2. 每一次重构的幅度要比较小。在开发软件过程中,开始重构2000行代码,3个小时以后发现所有的代码都不能工作,并且导致问题的原因无从查找,因此需要恢复到最初版本,几乎没什么事能比这更让人抓狂了。
8. 注释是恶魔
这条特殊戒律有一点争议,我们大多数人学到的是“注释是一个
好的习惯”,并且在一段晦涩的代码中有一段注释会比仅仅只有代码好的多,这里我的观点是:给晦涩的代码加注释还不如仅仅留下代码,只需要重构这段代码直到
它变得可读为止。(编注:当然了,除了作者说的这种类型的代码,在其他情况下,还是得添加必要的注释,这不仅方便自己日后查看,更有利于后来者维护,请参
阅《提高代码可读性的10个注释技巧
》一文。
9. 要面向接口编程,不要面向实现编程(Code to an interface, not to an implementation)
这是一条经典的原则,面向接口编程会让我们从实现的细节中解放出来,我们只要定义一个协议,并且依据协议调用定义的操作,期望(对方,即被调用的代码)能把实际的实现或者运行时态的实现传递给我们的代码。
10. 对代码进行复查
我们都会犯错误,没有什么能比请别人对我们代码做一个非正式快速复查更好的办法来查找错误了。最好不要等到代码都完成以后再复查,当某些重要部分的代码完成后,或者离上一次复查相隔几天之后,就进行复查。
分享到:
相关推荐
20210601-国泰君安-晶澳科技-002459-首次覆盖报告暨系列报告1:一体化布局显实力,老牌劲旅谱新章.pdf
苏美达集团 为何逆势成为新能源劲旅.pdf
新课改背景下的一支“奇兵劲旅”
交通运输行业周报:武汉迎来解封,山西物流劲旅揭牌
交通运输行业周报:武汉迎来解封,山西物流劲旅揭牌.pdf
南玻A-00001玻璃行业老牌劲旅,“电光”驱动增长可期.pdf
Scratch少儿编程项目音效音乐素材-【影视作品】音效-CCTV献礼片.劲旅如虹].专辑.(MP3).zip
半导体 电子行业 行业分析 数据分析 数据报告 行业报告
美食该如何制作?食品安全以什么为标准?用什么来检测食品成分?这么一份口香糖——糖果业的一支劲旅来为...该文档为口香糖——糖果业的一支劲旅,是一份很不错的参考资料,具有较高参考价值,感兴趣的可以下载看看
包含1391个指标,其说明文档参考: ...数据来源:基于上市公司公告数据整理 数据期间:从具体上市公司上市那一年开始-2022年度的数据,年度数据 包含各上市公司股票的、多年度的上市公司财务报表资产负债表、上市公司...
老牌劲旅看图软件ACDSEE 10.0全功能
仅需$ 27即可获得Ultimate Energizer(60%OFF)仅在http://bestproductforlife.com/theultimateenergizer/上获得-------------------------- ------------------------那里也有终极劲旅评论。 Ultimate Energizer...
消息中间件的实现有很多,有新贵Kafka、RocketMq,也有老牌劲旅RabbitMq和ActiveMq,不过我最后选择了Nsq来讲解,因为它极简、清爽,用起来舒服,讲起来也好理解,更重要的是,通过对Nsq的学习,我们很容易扩展到...
作为汽车电子和半导体制造业的老牌劲旅,意法半导体为这个合作关系带来了汽车半导体领域的重要技术和产品知识,以及通信和定位知识。VII计划面临很多挑战,像通道访问、通信可靠性、比现有解决方案更低廉的车辆...
作为汽车电子和半导体制造业的老牌劲旅,意法半导体为这个合作关系带来了汽车半导体领域的重要技术和产品知识,以及通信和定位知识。VII计划面临很多挑战,像通道访问、通信可靠性、比现有解决方案更低廉的车辆...
算法大全(数学建模):第一章:线性规划;第二章:整数规划;第三章:非线性规划;第四章:动态规划
算法大全: 1.线性规划 2.整数规划 3.非线性规划 4.动态规划 5....