附录 A 编码规范管理
程序代码编写规范
通常一个大型应用系统,都是由多人共同完成的。在这种环境下如何实 现相互之间的交流呢,这就要求同一个程序组的编程风格要基本一致。 这里,除了以上讲到的命令和界面要一致外,还包括程序代码的规范。 而程序代码的规范主要有以下几个方面的内容:
一、代码及注释规范
1. 代码中所有保留字的大小写要一致,这里我们规定都用小写; 2. 注释要求: 单元的头注释中要求指明的项目如下示例:
(******************************************************* * 建立日期:年 月 日; * 作 者: * 最近更新时间: ******************************************************* * 单元主要功能描述: * ******************************************************* * 修改记录 * ======= * 修改日期: * 修改原因: * 修改简要情况: *******************************************************)
过程和函数注释中除了指明该过程或函数的功能外,在该过程或函 数中的重要方法的语句的作用都要加注(显而易见的语句除外,当 然这个度是靠每个人自己把握)。 公用变量也要求被注释,以说明该变量的用途。
被引用自制构件或第三方构件单元,要求与系统中的单元区分开, 可另起一行,并在中间加入注释如:{ 以下为自制构件及第三方构
件单元}
被引用的单元要求注释如, uses DataMod; { 数据模块 } 3. 变量申明位置要求: 全局变量要求在程序接口部分的 var 下面申明; 公用变量要求在 public 部分申明; 私有变量要求在 private 部分申明; 对于用作 for 循环的变量,如 i、j、k 等应该在使用该变量的过程 或函数中去申明,不得在 public private 以及程序接口部分的 public、private var 下面申明; 只在一个过程或函数中使用的变量或方法,和用作 for 循环的变量 一样,应在使用该变量的过程或函数中去申明。 4. 引用单元位置要求:程序单元的引用可以在接口部分引用,也可执行部 分引用。一般情况下接口部分引用
系统单元,而自定义单元在执行部分 引用(如果自定义单元在接口部分引用请参见第 2 小点的注释及要 求)。如, implementation uses DataMod, { Data Module } BrCstOrd, { The Browse Orders by Customer form } BrParts, { The Browse Parts form } EdOrders; { The Edit Orders form } 当两个或两个以上单元循环引用时,应该使一个
程序单元在接口部 分引用另一个,而且另一个则在其执行部分引用前一个。 5. 代码缩格要求:每一层嵌套内应向后缩格 2 个字符开始。 6. 每一对的 begin end 都应该在相同的缩格位置上一一对应。 begin…end 7. 通用模块要求:在单元头的中应包含通用模块说明、输入参数及类型、 输出参数及类型
、属性和方法说明及其调用说明等。 8. 建立公用模块来定义自己的全局变量、过程和函数,以及数据库构件 等。
9.
应建立资源的概念,把用户看到的文字、消息(CAPTION、 MESSAGE)等作为资源来看待,编成资源文件让多个应用程序共享, 在程序中这些资源均用代码替代,做到整个系统的一致。
10. 当代码版本确定后,修改别人的代码或自己已经完成并提交过的代码 时,必须保留被修改的代码,并在修改和内容前后加注:{=== ........... yyyy/mm/dd xxx 修改 原因:y ===}和{=== yyyy/mm/dd 修改结束
===}之类的标识(可以英文)。
二、变量命名规则
变量的规范命名是增强程序可读性的重要举措之一。要力求做到在程序代 码中能一眼看出一个变量的可见度以及其数据类型。在所有的程序中使用统一 的规则对变量进行命名,这对于日后的修改和维护或是项目移交都是非常有益 的。 变量命名的规则也是<前缀> + <表意>。变量的命名主要是针对变量的可见 度和变量类型进行安装前缀以示其属性, 前缀除“结构类型”和“类类型”