(总账系统编程规范.docVIP

总账系统编程规范 （项目组编程规范） 总体目标 本文档制定的软件编码规范希望能达到以下目标： 易于移植 风格一致 易于理解 易于维护 代码简洁 编程容易 项目组成员个人编码风格的发挥在不违反以上目标的前提下进行。 本规范主要针对《商业银行综合业务系统》C编码编写。 本文档描述的编码规范由以下内容组成： 文件目录 文件命名 函数命名 变量命名 常量命名 文件首部 函数首部 函数定义 代码缩进 空间分隔 注释 代码排版风格 文件目录 源文件根据系统的划分来存放，同一个子系统的源文件放在相同目录下，公用的文件放在公用目录下。程序中关于对数据库的操作通过特定的函数进行，不允许出现SQL语句（注意：对于数据库操作的函数都放在一个单独目录下面，每个数据库表都有一个.ec程序，里面包含了所有有关该表的操作）。系统源文件目录主要划分成如下几部分： 源文件总目录（src） 一级目录： 系统初始化文件；(init) 系统启动过程中使用的文件 系统主函数；(main) 系统通讯main程序 Shell文件；(sh) 系统本身编写的shell文件 头文件目录；(incl_c) 子目录，保存.h文件，c声明方式 头文件目录；（incl_ec） 子目录，保存.h文件，ec声明方式 公共头文件；（incl_pub） 公用头文件、结构、变量、宏定义等 后台交易目录；(tx) 子目录，子交易文件（文件对应交易码） 公共函数文件；(pubf) 子目录，所有程序公用函数的文件 公共lib库文件；(liba) 外部.a文件 数据过渡目录；(tranf) 旧帐过渡源程序文件 二级目录： 后台交易目录：(tx) 会计业务子系统；(acct) 日终报表子系统；（rpt） 日终处理程序；（eod） 日终处理程序（报表除外） 主机管理目录：（host） (待定) 公共函数文件目录：（pubf） 会计业务；(acct) 报表业务；(rept) 公共基础函数目录：(base) 公共数据库操作目录：（pubdb） 通讯基础函数目录：（comm） 通讯基础函数目录：（bal） 系统初始化函数目录：（init） 日终函数目录：(eod) 注意：在pubf目录的子目录下都有一个.h文件，用来声明该子目录下的所有函数。 文件命名 文件名都用小写字母形式，便于阅读。 除了对数据库操作的文件为“.ec”程序之外，其他的所有程序都是“.c”程序。 头文件为“.h”形式。 头文件命名 以“表名.h”命名，表名用小写单词。 表名可以区分开存款、贷款、考核、柜员、凭证等项目。 例如： 现金台帐表（cash_mst）， 其头文件为 cash_mst.h 交易文件的命名 每个交易文件都对应一个交易码。 文件名：“sp_交易码.c” 使用sp_****??(service provider)命名，其中****表示交易代码，??表示序号 公共函数文件命名 英文单词缩写形式，多个单词之间用“_”连接。其缩写规则参考《规范1209》 文件名：子目录_英文单词缩写.c 例如：pub_cif_get_cif.c 表示该文件是公共函数库目录下客户中心文件目录的文件。 其他文件名 采用英文单词缩写形式。多个单词之间用下划线“_”连接。 代码结构 一个源文件中的代码构成一个代码模块。一个文件中的代码形成一个功能相对独立或属于某一共同特征的模块，属于不同功能组成的代码要求按不同文件存放。本编码规范要求每个源文件包含：文件首部、头文件、类型定义、全局变量定义、外部变量定义、函数声明（用来声明返回为空类型的函数）等。各组成部分用空行分隔，其中有些部分可能缺省，属于同一范畴的代码元素必须在一起集中定义说明。 功能与特征描述:??比较详细地说明本模块代码的功能与特征。 头文件说明区:??头文件说明区以注释行/* 头文件*/开头，然后是一行或多行C预处理器#include 指令。头文件说明区把模块中所有的头文件集中在一起进行说明。对系统和公有头文件的包含，要求使用#include stdlib.h形式；对私有头文件的包含要求使用#include “dd_mst.h”形式。 宏定义区:??宏定义区以注释行/* 宏定义 */开头，然后是一行或多行C预处理器#define和#undef指令（可能有条件编译指令进行控制），用以定义本代码模块使用的常数和宏定义。 类型定义区:??类型定义区以注释行/* 类型定义 */开头，然后是一行或多行类型定义语句。类型定义区给出本文件使用的结构等新类型的声明。 全局变量定义区:??全局变量定义以注释行/* 全局变量 */开头，然后是一行或多行全局变量定义。要求在同一行结尾处对定义变量