编写可维护软件的十大原则

编写可维护软件,可以提高软件开发效率,降低开发和维护成本。而要实现这一目标,软件开发人员应当遵守以下10大原则:

  1. 编写短小的代码单元

这里的代码单元,指的是方法或函数。

短小的代码单元(一个经验法则是一个代码单元规模不超过15行),可读性好,易于分析、测试和重用,因此可维护性好。

  1. 编写简单的代码单元

这里的“简单”,指的是拥有更少的决策点(一个经验法则是一个代码单元分支不超过4个)。简单的代码单元,同样易于分析和测试。

  1. 不写重复代码

编写代码应当避免复制粘贴已有的代码。因为一旦对代码重复使用,在修改时就需要对每行代码进行修改,如果稍有疏忽,遗漏了部分重复代码,就会给软件带来Bug。而且重复代码也是回归测试产生Bug的一个来源。重复的代码应尽量即将起提取到一个方法中来。

  1. 保持代码单元的接口简单

这里的代码单元接口实际上指的是代码单元的参数(一个经验法则是一个代码单元参数不超过4个)。含有更少参数的代码单元易于测试和重用。

  1. 分离模块之间的关注点

这里的“模块之间的关注点”指的是模块间的耦合程度,分离模块之间的关注点就是要使得模块要高内聚松耦合。松耦合的模块更易于修改,也利于构建更加模块化的系统。

  1. 架构组件松耦合

这里的“架构组件”强调的是软件的顶层(高层级)组件。一个组件是由一个或多个模块组成的。软件的顶层组件之间越是松偶合越易于修改,也利于构建更加模块化的系统。

  1. 保持架构组件之间的平衡

组件之间的平衡有三层意思:一是同一层级的组件数量不会太多也不会太少(一个经验法则是组件数量不超过9个);二是同一层级的组件规模相差无几;三是各组件是松耦合的。一个平衡度很好的架构可以使得修改更加容易。

  1. 保持小规模源代码

应尽可能使得最终软件的源代码规模小。软件源代码规模越大越难以维护,因为需要分析、修改、测试更多的代码,而且效率也比小规模的源代码低得多。

  1. 自动化开发部署和测试

自动化测试可以对修改的有效性得到及时的反馈,它的高效是手工测试无法比拟的。而且自动化测试可以有效地提高开发效率,降低开发过程中遗留的Bug数量。

  1. 编写简洁的代码

代码中存在的无用代码和注释越多,就会给维护人员阅读和理解代码带来越大的障碍,从而影响维护工作的效率。

这正是:

软件追求可维护,十个原则要遵守

别人经验要汲取,自己软件质量优

参考书目:代码不朽:编写可维护软件的十大要则,作者:(荷兰)约斯特·维瑟,译者:张若飞,出版社:电子工业出版社

(0)

相关推荐

  • 《程序员修炼之道》| 王木头解读

    关于作者 这本书的两位作者分别是大卫·托马斯和安德鲁·亨特,他们不只是非常资深的程序员,还是<敏捷软件开发宣言>17位创始人中的2位.他们为敏捷软件开发建立起了价值观和基本原则. 关于本书 ...

  • Proe/Creo产品结构设计的十大原则

    作为产品结构工程师,在结构设计中要注意的事项太多了,我把多年的经验总结一下(这里的产品适用于大批量.流水线生产),不一定对每个行业产品都适用,每个人也有不同的经验,仅在此抛砖引玉. 一.外观严格按照工 ...

  • 危机沟通的十大原则

    危机沟通的十大原则

  • 做人与做事 十大原则

    第一 办事要讲原则 没有规矩,不成方圆.原则就是办事的方圆,成事的规矩,行事的底线.一旦突破了这一底线,纵有多少技巧和方法,也将成为无源之水,无本之木. 对人 宽容 坦诚 尊重 信任 公正 对已 守信 ...

  • 庭院风水系列(五):庭院设计时布局风水十大原则

    在设计庭院的时候注意风水的好处就是可以避开不好的事物,对于事业与生活都有帮助,别墅庭院风水有他的禁忌所在,如何来将这些不好的事物避开呢?  只需要设计师在设计庭院时注意以下十大原则: 一.统一原则:统 ...

  • 嵌入式开源软件的十大弊端

    俗话说得好,"得来全不费功夫",免费当然是个好事情了.既然是免费的, 开源的实时操作系统(RTOS)看起来是个不错的选择. 但是对于嵌入式设备和物联网设备的开发者来说, 有时并不愿 ...

  • 通达信软件的十大实用小功能,赶快收藏起来

    通达信软件在一些细节处同样处理得非常恰当,现在就来发掘这些实用的"隐藏"功能吧 1.多条均线的设置以及指标后的升降小箭头: MA+回车键或者MA2+回车键,再或者使用快捷键Alt+ ...

  • 提高数商的十大原则

    提高数商的十大原则

  • 做人的十大境界、十大原则、十大醒悟、十大心机、十大智慧!

    中国传统文化就是做人的文化. 有一位求道者感觉很迷茫,不知如何是好,便去请教道长. 中国传统文化是世界三大文化体系之一,在上古时代就是独立发展的,形成人类文化的一个独立典型,直到21世纪,中国传统文化 ...

  • 高速行车的十大原则

    高速行车的十大原则