PB命名约定.doc

应用系统源程序基本规范 程序命名规则 命名方法之所以要标准化，主要出于以下几个目的。 即使只从名字，也可以判断出起什麽作用？ 是何种类型？ 提高了可读性及可维护性； 避免编译及链接时的冲突/不一致，而这种冲突/不一致在把一些模块移到别的一些操作系统中时有可能发生； 阅读源程序以及进行调试时，某个符号属于哪一个模块，能很快的明白； 和用途直接有关的固有名词的使用， 能够防止由于疏忽而错误地使用于别的用途。对于变量来说，一个用途一个变量是一个重要的原则； 可维护性。 命名的方法是随着软件系统开发使用的编程语言和编程工具的不同而变化的。 例如：编程语言的不同决定了可使用的字符，X-Windows编程时使用X-Windows形式的命名原则 因此，详细的规定必须根据项目Project的不同情况而定。“开始编程之前，必须设定编程详细准则”是一个必须遵守的原则。以下，将阐述我们在设定详细准则时，一些必须考虑到的基本原则，并提供一些范例。 标识符是程序中用来代表变量、标号、函数、窗口、菜单、控件和对象等名称的符号在源程序中使用的标识符（变量，函数，文件），应该满足下列基本条件： 必须以字母或下划线开头； 其它可以是字母、数据及些特殊符号； 最长为40个字符，中间不能有空格； 保留字不能作为标识符； 根据其名称，可以容易地推断它的用途； 根据其名称，可以容易地推断变量的作用域和类型 变量的命名及定义 对于PB来说，它有五个系统预定义的全局的变量：SQLCA、SQLDA、SQLSA、Message、Error，这五个变量名在程序中不要显式定义，其它变量名的定义遵循如下规则： 权限（A） + 类型缩写（B） + _ + 拼音缩写、英文（C） 说明：（1）、定义的变量一律小写； （2）、权限（A）列表： 权限 缩写 全局变量 g 共享变量 s 实例变量 i 局部变量 l （3）、类型缩写（B） 数据类型 缩写 Bolb Bb Boolean B Char 或 Character C Date D DateTime Dt Dec 或 Decimal Dc Double Db Integer 或 Int I Long L Real R String S Time Tm UnsignedInteger 或 Unsignedint 或 Uint Ui UnsignedLong 或 Ulong Ul （4）、拼音码缩写（C）:能表达此变量用途的中文拼音缩写 例如：统计数据窗口返回的总行数则可定义变量 Int li_zhs （5）、例子：Int li_zhs Long ll_hd 变量的定义遵循如下语法： 数据类型{{精度}} 变量名{[数值]} {=初值}{，变量名{[数值]} {=初值}….} 说明：（1）、数据类型采用首字母大写，其它小写； （2）、变量的命名以上面的规定为准。 变量的定义注意点： （1）、一个变量一个用途 一个变量，只使用在一个用途上，决不用于复数个用途上。无论是在开始编程阶段，还是在维护的阶段做功能追加及变更时，都应该遵守该原则。但是局部的循环记数变量属于例外。 （2）、一个文字的变量名 一个文字的变量名如 i,j等 尽可能不要使用。 尤其不能在全局变量中使用。如果使用了，当某个功能发生变更时，将导致和该变量有关部分要变更。要检索出使用了该变量的部分很困难。全局变量等重要的变量至少使用2文字以上的字符，这样使用编辑器可以无遗漏地方便地检索出。 （3）、给变量名一个正确的含义 使用正确的名字给变量命名，即变量名和用途相符合， 以免维护人员产生错误的理解。（能用英文单词修饰尽量用英文单词，否则用拼音码缩写）。 （4）、变量全部小写 PB对象的命名 部分PB对象前缀： 结构 str 用户对象 u 菜单 m 生成新的对象后必须在库中对象的属性中加入注解。 （1）、函数： 应用系统级：f_拼音缩写、英文 窗口级： wf_拼音缩写、英文 用户对象级：uf_拼音缩写、英文 菜单级： mf_拼音缩写、英文 （2）、结构： 应用系统级：str_拼音缩写、英文 窗口级： wstr_拼音缩写、英文 用户对象级：ustr_拼音缩写、英文 菜单级：