如何提高软件的可维护性

如何提高软件的可维护性
汪若虚 （ 中国电子科技集团公司第４１研究所， 安徽 蚌埠 ２３３０００）
［ 摘 要］ 本 文 简 要 地 介 绍 了 软 件 可 维 护 性 的 概 念 ， 从 程 序 结 构 、控 制 的 数 据 化 、程 序 注 释 、文 档 的 编 写 、自 适 应 构 件 的 设
计 、调 试 模 块 的 编 写 等 几 个 方 面 较 为 详 细 地 阐 述 了 如 何 在 程 序 设 计 过 程 提 高 软 件 可 维 护 性 的 方 法 。
＊ ［ 收稿日期］ ２００７－ ０９－ ０９
［ 作者简介］ 汪若虚（ １９７０－ ） ， 男， 汉族， 蚌埠市人， 硕士。
１３２ ＸＵＥＢＡＯ
２００７．１２．２０
技术园地
汪若虚— ——如何提高软件的可维护性
第６期
信息增减而不断更新的通信数据格式的要求， 我们就采 用了程序控制的数据化技术， 在这套软件中我们不是利 用代码来产生无数个条件来解释由控制器传来的故障信 息， 而是为通信数据包建立了一个索引表， 利用索引数据 来控制数据解释， 具体的做法如下：
得程序变得容易理解， 但它们的输入却成了编程者的一
种负担， 同时也增加了误输入的机会。这里， 我向大家介
绍 一 种 介 于 这 两 个 极 端 之 间 的 命 名 方 法 — — — 匈 牙 利 命 名
法： 这种方法， 在一个较长的并具有描述性名字前， 加上
一个短的前缀来产生有用的变量名， 前缀描述了该变量
的数据类型， 甚至还可以描述该变量的使用方法。例如：
ｃｈａｒ
ｃｈ；
ｃｈａｒ
ａｃｈＦｉｌｅ［ １２］ ；
ｃｈａｒ ｆａｒ ＊ｌｐｓｚＮａｍｅ；
ｉｎｔ
ｃｂＮａｍｅ；
请注 意 ， 前 缀 都 是 小 写 的 ， 而 长 名 字 却 是 大 、小 写 结
合的。上面第一个变量ｃｈ， 是字符类型的前缀， 它直接用
目前， 软件维护越来越引起业内人员的重视， 维护的 手段和工具也越来越多， 如Ｒａｔｉｏｎａｌ公司的ＰＵＲＥ软件包、 ＣｌｅａｒＣａｓｅ软件包等， 但软件维护工作中最重要的因素还 是“人”， 从软件设计开发伊始， 软件研制人员就应该从方 案 、人 员 分配 、程 序 编 写 等 诸 多 方 面综 合 考 虑 ， 为 以 后 的 软件维护工作预留出操作空间， 提高软件的可维护性， 同 时也有利于提高软件的可靠性。
序注解的习惯， 实用的程序注解对以后维护软件有相当
大的帮助。
程序的注解的书写应遵循以下的原则：
１． 使用容易理解的变量名称
不要以为程序注解仅仅是程序行尾部的说明， 容易理
解、和其作用关联的变量名称， 也是一种非常好的注解。
使用短的变量名称， 它虽然易于输入， 但却使你的代
码难以理解； 使用具有描述性的的长变量名， 虽然可以使
ｆｏｒ （ｓｕｍｇｚｄ ＝ １２， ｉ ＝ ０； ｉ ＜ ＺＢＵＦＮＵＭ； ｉ＋＋） ／／ 处 理 故 障信息
｛ ｄａｔａ ＝ ｇｂｚ［ ｉ］ ； ｆｏｒ （ｊ ＝ ０； ｊ ＜ ８； ｊ＋＋） ｛ｋ ＝ ｚ＿ｇｚｄｃ［ ｉ＊８＋ｊ］ ； ／／ 得到故障信息的索引数据 ｉｆ （ｋ ＜ ０） ｃｏｎｔｉｎｕｅ； ／／ 索引数据＜０， 不需解释
数据类型 数 组 （复 合 类 型 ） 字符 字节计数 无符号长型 索 引 （复 合 类 型 ） 长整型 长指针 整型
近指针 一个（ｘ，ｙ）点 一种矩形结构 以空字符为结束符的字符串 无符号整型
如果你适应了匈牙利命名法， 将会帮助你写出易读、
２００７．１２．２０
ＸＵＢＡＯ １３３
技术园地
汪若虚— ——如何提高软件的可维护性
［ 关键词］ 软件维护； 控制数据化； 注释； 文档； 自适应构件； 调试模块
［ 中图分类号］ ＴＰ３１１．５３
［ 文献标识码］ Ｂ
软件本身是一种产品， 也需要对它进行维护。正因为 如此， 从软件诞生的那一天起， 软件维护的问题便随之应 运而生。起初的软件都比较简单， 程序的行数少， 代码短， 也没有许多文档， 基本上处于程序员单枪匹马工作的方 式， 因而软件维护也比较简单； 随着软件产业的迅速发 展， 软件已不再是简单的程序， 还包括了日志、记录、操作 说明等诸多文档； 软件的生产也不再是单个程序员的事 情， 而是有一个工作小组中的许多人共同协作完成， 软件 维护也相应得复杂起来。
出各模块间的调用关系和数据交换方式。这样， 不仅可以 使创作团队中的各成员可以并行、独立编写其中的一个 或几个模块， 而且可以使得以后的软件维护以较小的模 块为单位进行， 而不必因为一个小小的维护而修改全部 的软件代码。
２． 预留出一定的空余编码以供扩展 空余编码包括程序空余编码和数据空余编码。由于 用户对需求的模糊和设计人员对需求理解的偏差， 软件 编写之初， 不可能把所有需求全部实现， 这就要求设计人 员在方案设计时， 除了完成已知的需求任务外， 必须预留 充足的编码空间， 再加上采用本文后面将介绍的一些技 术， 使得软件的扩展相当容易（你甚至可以不用修 改任 何 控制代码， 只需在指定的表格中填加一些数据即可）。 ３． 函数体（对象）的封闭性 函数 体（对 象）的 封 闭 性 是 指该 段 代 码 在 程 序 控 制 方 面不影响其它代码的执行， 在数据方面除了接口数据外 不影响其它的数据。这一点对日后改进软件算法至关重 要， 只有这样， 才有可能对某一函数进行修改而不意外地 破坏整个软件。 二 、程 序 控 制 的 数 据 化 实际上， 对控制代码的修改不仅烦琐， 而且出错的概 率也会增大， 降低软件的可靠性， 不利于软件的维护， 因 此在软件维护时， 如果能不修改控制代码就尽量不修改 控制代码。我们设想如果仅改变程序中的数据， 就可以实 现对程序控制的修改， 这就是程序控制的数据化。 乍一看， 似乎这种技术是相当复杂的， 但如果你实际 实施起来， 并不见得非常困难， 利用一些我们经常使用的 方法就可以达到这个目的。 在我研制的一个软件中， 操作台需要解释由控制器 送来的故障信息并以图形形式显示出来。为了适应由于
ｉｆ （ｇｚｄ［ ｋ］ ．ｎｕｍ＆０ｘ８０００） ｃｏｎｔｉｎｕｅ；／／ ｎｕｍ．１５＝１ 表 示屏蔽该故障
ｉｆ （ｇｅｔｂｉｔ（ｄａｔａ，ｊ）） ／／ 如数据包指示该故障存在 ＧＺＤＢＵＦ［ ｓｕｍｇｚｄ＋＋］ ＝ｋ； ／／ 则 添 加 故 障 编 号 入缓冲区 ｝
｝ 其中， ｓｕｍｇｚｄ为当前故障计数， ＺＢＵＦＮＵＭ为故障数据 包的字节数， ｇｂｚ为故障数据包缓冲区， ＧＺＤＢＵＦ为当前存 在的故障信息缓冲区， 函数ｇｅｔｂｉｔ检测数据ｄａｔａ的第ｊ位， 如 果为“１”则返回真， 为“０”返回假。 这样， 当故障信息数据由于诸多原因发生更新时， 操 作台软件只需更改这个索引表即可。它不仅极大提高了 编程效率， 同时大家都可以看出， 它也提高了编写的软件 的可维护性和可靠性。 三 、实 用 的 注 解 程序的注解， 是对程序代码进行解释、对编程思想进 行阐述的有效手段。在编写程序时， 应该养成即时书写程
要使编写的软件具有较强的可维护性， 设计人员就 必须从软件的方案设计起， 树立起软件维护的概念， 只有 这样， 才有可能在以后的程序设计中给软件维护预留出 操作空间。
一 、合 理 的 程 序 结 构 合理的程序结构不仅有利于软件的维护工作， 同时
也是团队集体创作的前提。 １． 软件的模块化 根据需求， 将软件划分为几个相互独立的模块， 定义
作 变 量 名 ； 变 量 名ａｃｈＦｉｌｅ的 前 缀 具 有 两 部 分 ， 其 中ａ意 味
着这是一个数组， 而ｃｈ则给出了这个变量的数据类型； 同
样， 变量名ｌｐｓｚＮａｍｅ的前缀也是有两部分， ｌｐ指出这是一
个长指针， ｓｚ说明该变量是一个以空字符 结 尾 的 字 符 串 ；
变 量 名ｃｂＮａｍｅ 的 前 缀 ｃｂ则 告 诉 我 们 该 变 量 保 存 了 对 字 节
第６期
易于维护的程序来， 同时， 这种对变量的命名法则也适用
于对函数的命名上。
２． 对变量作出详细的解释
匈牙利命名法虽有助于我们对变量的理解， 但其毕
竟是一种缩写符号， 并不能完全解释一个变量的用法， 为
了日后的软件维护， 在变量定义时， 我们应尽可能对其作
详细的解释， 包括它的作用、变化范围和用法。
表中的每个数据按故障数据包中的顺序对应于其上 的每一位， 这个数据给出用于解释该位数据的故障信息 编 号 。如 该 表 的 最 后 一 行 的 第 一 个 数 据“３８７”表 示 故 障 数 据 包 中 的 第 ３９个 字 节 的 第 ０位 应 使 用 第 ３８７条 故 障 数 据 来 进行解释。如果故障数据包中的某一位无意义， 不用解释 则将该索引数据填为“－ １”。然后在对故障数据进行解释 时， 我们编写了如下的代码：
的计数。使用这种命名方法可以有助于我们理解我们编
写的程序：
ＬＰＳＴＲ ｌｐｓｚＮａｍｅ， ｌｐｓｚ；
ｉｎｔ
ｃｂＮａｍｅ；
ｆｏｒ （ｌｐｓｚ ＝ ｌｐｓｚＮａｍｅ， ｃｂＮａｍｅ ＝ ０； ｌｐｓｚ ！ ＝’＼０’；ｌｐｓｚ＋＋，
ｃｂＮａｍｅ＋＋） ；
下表中列出了我们经常使用的一些前缀：
前缀 ａ ｃｈ ｃｂ ｄｗ ｉ ｌ ｌｐ ｎ ｎｐ ｐｔ ｒ ｓｚ ｗ
一种软件在发布之后， 不可能是一成不变的。在软件 的测试阶段， 你不可能对软件的所有可能都进行全面的 测试， 因此软件中存在缺憾是不可避免的， 发现之后， 你 就需要对其进行修改； 在用户使用的过程中， 他可能会感 觉 到 某 些 使 用 不 便 的 地 方 （每 个 用 户 的 感 觉 可 能 都 不 同 ）， 以用户是上帝的原则， 你也需要改写相应的代码； 随着时 间的推移、用户和市场的反馈， 你需要不断地对软件进行 升 级 ， 增 加 新 的 功能 、抛 弃 无 用 的 功 能 、改 进 其 中 的 某 些 算法， 以满足时刻发展的市场要求。这些工作， 都是在对 软件 进 行 维 护 ， 此 外 软 件 维护 还 包 括 ： 软 件 的 扩 展 、文 档 的 记 录 、操 作 说 明 的 修 改 、对 用 户 的 技 术 支 持 等 。