广东电信综合业务支撑系统(IBSS)总体设计说明书-开发规范分册(V2.0)

文档编号：NF_T_IBSS-JS_03 版本：v1.0密级：机密

广东省电信

综合业务支撑系统

（IBSS）

开发规范说明书

编制：部门／职位：日期：__________

审核：部门／职位：日期：__________

批准：部门／职位：日期：__________

广州南方电信系统软件有限公司

版权所有不得复制

目录

第一章引言 (4)

1.1编写目的 (4)

1.2背景 (4)

1.3文档地图 (4)

1.4术语定义 (4)

1.5参考资料 (4)

第二章通用编码规范 (5)

2.1排版 (5)

2.2注释 (5)

2.3命名 (6)

2.4可读性 (6)

2.5变量 (6)

2.6函数、过程 (6)

2.7可测性 (7)

2.8程序效率 (7)

2.9质量保证 (7)

2.10代码编译 (8)

第三章 DELPHI前端开发设计规范 (9)

3.1软件模块设计 (9)

3.1.1 开发工具 (9)

3.1.2 文档的建立和管理 (9)

3.1.3 版本控制 (9)

3.1.4 注释和功能描述 (10)

3.1.5 菜单打开窗体的引出函数声明 (10)

3.1.6 修改 (10)

3.1.7 发布的公用资源，多使用类 (10)

3.2编码设计 (11)

3.2.1 命名规则 (11)

第四章 CICS开发规范 (19)

4.1命名规则 (19)

4.1.1 通用规则 (19)

4.1.2 Program命名 (20)

4.1.3 函数/过程命名 (20)

4.1.4 变量命名 (20)

4.1.5 宏定义 (21)

4.2程序的书写规范 (21)

4.2.1 嵌入式SQL 的书写规范 (21)

4.2.2 空行 (21)

4.2.3 代码行 (21)

4.2.4 对齐 (22)

4.2.5 修饰符的位置 (22)

4.2.6 注释 (22)

4.3开发注意事项 (23)

4.3.1 平台支持 (23)

4.3.2 CICS Program 中禁止使用的函数 (23)

4.3.3 CICS Program 中不推荐使用的函数 (23)

4.3.4 宿主变量（Host Variable）可用数据类型 (23)

4.3.5 数据类型兼容 (24)

4.3.6 Char 数据类型的使用 (24)

4.3.7 Varchar数据类型的使用 (24)

4.3.8 统一编译选项 (24)

4.3.9 统一日期格式 (24)

4.3.10 字符集 (25)

4.3.11 防止头文件的多重包含 (25)

4.4开发建议 (25)

第五章数据库设计规范 (26)

5.1数据库中对象命名原则 (26)

5.2数据库中对象前缀的定义 (26)

5.3库表命名原则 (26)

5.4库表类别划分 (27)

5.5字段命名规则 (28)

5.6字段类型规范 (30)

5.7存储过程和触发器命名规则 (30)

5.8主键和索引命名规则 (30)

5.9设计规则 (30)

第一章引言

1.1编写目的

为了规范设计和代码风格，提高代码质量，增强程序的可读性和可维护性，特编写本文档。

预期读者：项目提出方以及用户方相关技术人员、项目开发组成员、质量控制人员。

1.2背景

系统名称：综合业务支撑系统

项目提出人：广东省电信公司

项目开发者：广州南方电信系统软件有限公司

用户：广东省电信公司、广东省电信公司地市级分公司

1.3文档地图

本文档定义了开发的规范，包括以下几个方面：

通用编码规范

DELPHI前端开发设计规范

CICS中间件开发规范

数据库设计规范

1.4术语定义

无。

1.5参考资料

●《广东省电信综合业务支撑系统业务需求分析书 V2.0》广东省电信公司

●《广东省电信综合业务支撑系统技术规范》广东省电信公司

●计算机软件产品开发文件编制指南[GB 8567-88]

●计算机软件质量保证计划规范[GB/T 12504-90]

●计算机软件配置管理计划规范[GB/T 12505-90]

第二章通用编码规范

2.1排版

关键词和操作符之间加适当的空格。

相对独立的程序块与块之间加空行。

较长的语句、表达式等要分成多行书写。

划分出的新行要进行适应的缩进，使排版整齐，语句可读。

长表达式要在低优先级操作符处划分新行，操作符放在新行之首。

循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。

若函数或过程中的参数较长，则要进行适当的划分。

不允许把多个短语句写在一行中，即一行只写一条语句。

函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。

C/C++语言是用大括号‘{’和‘}’界定一段程序块的，编写程序块时‘{’和‘}’应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

2.2注释

注释要简单明了。

边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。

在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防止注释二义性。保持注释与其描述的代码相邻，即注释的就近原则。

对代码的注释应放在其上方相邻位置，不可放在下面。

对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释应放在此域的右方；同一结构中不同域的注释要对齐。

变量、常量的注释应放在其上方相邻位置或右方。

全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；主要函数或过程清单及本文件历史修改记录等。

在每个函数或过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等。