4GL语言开发原则及规范--简化版.docVIP

4GL语言开发原则及规范 中科软件股份有限公司 2002年04月27日  目 录 1 编码规范 1 1.1 命名规范 1 1.1.1 对象命名 1 1.1.2 常量和变量命名 5 1.2 注释规范 7 1.2.1 程序文件部分的注释 8 1.2.2 函数部分的注释 9 1.2.3 函数（过程）程序的增、删、改的注释说明约定 11 1.2.4 函数体内部的代码段修改注释 12 1.2.5 函数体内部的代码段说明约定 13 1.3 书写规范 13 1.3.1 基本原则 13 1.3.2 保留字引用规则 14 1.3.3 LET语句 14 1.3.4 IF语句 15 1.3.5 DEFINE语句 15 1.3.6 CALL语句 16 1.3.7 函数体内部组织 16 1.4 注意事项 18 编码规范 命名规范 对象命名 数据库命名规范 数据库名长度：不超过INFORMIX规定长度(十八位)DB； 举例：财产保险业务处理系统的数据库命名为：PrpInsDB 系统名由英文单词构成，每个单词大写长度：不超过INFORMIX规定长度(十八位)_”组成形式，规则如下： 数据库表名由三部分组成：系统名+业务类型+表的英文名（+“_”+子对象名），业务类型用1位大写字母表示，如承保业务为C、批改业务为P、理赔业务为L、收付费业务的数据表为J、通用代码为D； 举例：财产保险承保保单基本信息表命名为：PrpCmain； 货物运输保险保单信息表（继承了保单基本信息）：PrpCmain_Cargo。 业务类型采用附表提供的词根表中规定的字母； 表名由英文单词构成，大写_”分割； 举例： PrpCmain_Cargo：货物运输保险保单信息表，继承了保单基本信息。 附表提供的词根表作为构词的唯一依据。 本小节规范适用于各种语言版本的系统。 数据库字段命名规范 字段长度：不超过INFORMIX规定字段长度(十八位)采用英文形式，规则如下： 字段名由英文单词构成，单词大写单号：olicyNo 一个字段名所用的单词不超过5个，在字段名不超过规定长度的情况下，尽量采用英文单词的全称在字段名总长度超长的情况下，不缩略核心单词，其他单词缩略不短于个字母长度：不超过INFORMIX规定长度(十位)采用英文形式，规则如下： ObjectOpt.4gl 其中，Object 是对象名。数据层默认为基本表名。如果表名超过10位。则按照缩略规则执行。 BL层模块划分及命名： 原则上每个BL层的对象对应两个模块，一个对象主模块，一个模块存放归属于该对象的模块变量。当且仅当主模块中内容过多时，按照如下规则划分： objectRd.4gl：存放涉及到查询（读）数据库的服务函数 objectWt.4gl：存放涉及到更新（写）数据库的服务函数 objectTx.4gl：存放事务服务函数 objectLg.4gl：存放不涉及数据库操作的服务函数 DB层模块划分及命名： 全局动态数组（DE）：对于数据层的实体对象服务模块，它们一般由工具生成，文件名一般要与实体对象名一致，除非表名超过10位，此时参考词根表进行命名。注意表名或者词根表是命名仅有的参考依据。另外，除了通用服务以外，有些实体对象需要一些扩展的服务，这些服务放在实体对象服务模块的最后定义； 函数命名规范 采用由大小写英文字母和“_”组成方式，规则如下； 直接调用的工具函数命名公式 pub_” + ”对象名” + ”_” + “函数名” 其中：对象名和函数名区分大小写 对象服务函数命名 由于INFORMIX-4GL语言不是面向对象的开发语言，因而在程序设计中的对象服务是以函数的方式体现的； 一般函数命名公式： 作用范围+”_”+对象名+”_”+对象的方法 其中：作用范围包括pub/pri，对象名和方法名区分大小写 举例：逻辑层险种对象BLPrpDrisk的增加操作add 所对应的函数名为：pub_BLPrpDrisk_Add 数据层代码对象DBPrpDcode 的delete 操作 所对应的函数名为：pub_DBPrpDcode_Delete 界面层保单对象 UIPolicy 的 录入操作对应的函数名为：pub_UIPolicy_Input 事务型的函数(或模块)命名规范参见3.2.5(数据库事务编写约定) 数据层扩展服务函数命名： 如果存在某数据表TableName的数据层服务，其功能是获取表中某字段ColumnName的最大值，则该数据层服务函数名定义为： pub_DBTableName_GetMaxColumnName 如果某两层结构数据表TableName的字段名为Col，现存在数据层服务，其功能是根据Col删除表中数据，则该数据层服务函数名定义为： pub_DBTableName_DeleteByCol 如果某两层结