咱们都知道,一个软件的维护成本每每要高于其研发成本。在维护过程当中,咱们的代码须要不断的进行迭代。迭代的目的有两个:修复bug和增长新特性。可是迭代也会带来一系列新的问题,好比新的bug,或者是破坏代码的整洁性。这里咱们从保持代码整洁性的角度来讨论一下迭代的几个原则。程序员
运行全部测试web
没错,首先的要说的仍是测试,咱们要在每次迭代代码以后,运行全部的测试,若有必要,也要编写新的测试。咱们要编写尽可能简单的测试,简单的测试会驱使咱们下降类与类之间的耦合度。若是还不了解如何编写单元测试,能够参考一下旧文代码洁癖系列(七):单元测试的地位。良好的测试不可是代码质量的保证,同时也是良好设计的引导。微信
不要重复“造轮子”编辑器
记得个人leader曾经告诉过我:写每一行代码以前,要先思考一下有没有必要写这行代码。在实现一个功能以前,先确认一下这个功能是否已经被实现了。永远不要重复“造轮子”。可是,当咱们进行必定的共性抽取时,可能已经违反了SRP原则(Single Responsibility Principle)。所以,抽取出的方法可能须要放在其余类中。函数
可读工具
代码是程序员之间的交流工具,要想得到其余程序员的尊重,必须使你的代码具有可读性。这也是咱们要保持代码整洁的缘由。如何保证代码的可读性呢?首先须要的就是有意义的命名,关于命名规则,能够参考代码洁癖系列(二):命名的艺术这篇文章,其次就是经过测试用例让别人了解你的代码。单元测试
尽量少的类和方法测试
在代码洁癖系列(三):整洁的类和函数一文中,咱们说过类和函数都应该尽可能短小。有人问了,为了类和函数都足够短小,我要把代码拆分红许多的类吗?这里须要说明一下,在这方面,咱们并不须要追求极致。应该根据实际状况,合理的拆分。因此,也要尽可能减小类和方法,这可能与“类和函数应该短小”这一原则相矛盾。这须要工程师本身去衡量了,首先要保证“类和函数应该短小”,其次才是尽量减小类和方法。flex
结束语spa
到这里,”代码洁癖系列“的文章要告一段落了,但愿你们在写代码的时候能够多思考,保证本身代码的整洁性。文章有什么问题,或者我有哪些遗漏的地方,你们能够经过去个人微信公众号后台留言和我讨论。

本文分享自微信公众号 - 代码洁癖患者(Jackeyzhe2018)。
若有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一块儿分享。