规则、惯例约定.doc

《规则、惯例约定.doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、规则、惯例和约定编号：GT/KF-038-2006编写说明：此部分分为编程语言规范和界面设计规范两个部分，其中，编程语言编程规范，在每个项目中，按照此模板定义，由项目负责人或者项目负责人制定人员进行编制；界面设计规范如无特殊要求，引用该规范即可；编程语言编程规范1使用命名约定命名约定可以有很多种，重要的一点是要始终如一的运用它，使别人看你的程序时易于理解、不言自明。至少别人能区分出你使用的变量类型、变量的作用范围、常量、以及过程。1.1命名变量和常量通常的命名约定使用小写字母的前缀和后缀来指明变量的类型和作用范围。变量本身是一个有意义的名字，可以简单描述出该变量的含义以及它的作用，可以多个

2、单词组合起来，每个单词的首字母大写、单词之间不使用下划线。常量的名字一般采用大写的形式并使用下划线分隔各单词。变量名中也包含两个或三个字符的前缀，用以指明变量的数据类型。例如， DimstrRecipientNameasStringDimobjXLAppasObject全局和模块级变量再使用一个前缀字符指明变量的作用范围。变量的作用范围定了变量的生命周期以及变量的可见性。可以使用“g”作为前缀声明一个全局变量。过多的使用全局变量会使你的代码难以理解和难以维护。模块级变量使用小写字母“m”作为前缀，在类模块中可以用“P_”作为变量名前缀。静态过程级变量使用小写字母“s”作为前缀。下面是使用前

3、面介绍的通用命名原则命名的一些变量示例变量数据类型作用范围 strCompanyNameString过程rstCurrentOrdersObject过程mcolCurrentUsersObject模块gstrLogonIDString全局1.2命名对象和控件对象和控件一般采用前缀+名称的命名方式。前缀指明了项目，大小写混用的名称指明项目的用途。例如，lblCompanyName,cmdClose,txtUserName,frmMain等。1.3命名函数和子过程当命名过程时，应使用NounVerb(名词动词)或VerbNoun(动词名词)的格式来为过程起名，以便清晰地说明过程的作用。没有必要

4、使用前缀或后缀来指示返回值。例如，UserAdd().FindString()当创建带有参数的过程时，参数名称也采用变量命名约定。例如，FunctionRemoveString(ByValstrSourceAsString,strStartAsString,OptionalintEndCountAsInteger=0,OptionalblnReturnChunkAsBoolean=False)AsString当你调用接受可选参数的内置方法、定制方法或过程时，总是使用命名参数来代替位置参数。命名参数使程序代码易于理解、调试、以及维护。命名参数是参数名后面跟有冒号和等号（:=）、再跟参数值的参

5、数。下面示例的第一行展示了如何调用使用占位参数的定制过程：第二行展示了如何调用使用命名参数的定制过程。strModifiedString=RemoveString(strOriginalString,strStartHere,strEndHere,,True)strModifiedString=RemoveString(strSource:=strOriginalString,strStart:=strStartHere,strEnd:strEndHere,blnReturnChunk:=True)1结构化和格式化代码如何运用结构化编码约定直接影响代码的理解性和易维护性。在你的代码中运用结

6、构化方法的一般原则对应用程序级、模块级以及过程级都会有一定的效果。格式化方法的使用（折行、空白、以及缩进）有助于显露每个过程的逻辑和结构。在应用程序级，你的代码包含在一个或多个标准模块或类模块中，通过逻辑方式组织代码，可以实现这个层次的代码结构化。在模块内部各个过程之间应该存在某种关系。例如，可以把所有访问数据的代码保存在一个模块中。在过程级，运用结构化编码方法意味着庞大的过程拆分成较小的过程，并使用折行、空白、以及缩进组织代码的逻辑结构。格式化代码的基本技巧包括运用折行、空白、以及缩进。除了让代码易于阅读外，这些格式化技巧通过展示过程的逻辑结构和流程以及通过把代码分组为相关的节来使代码文

7、档化。2有效地运用注释注释应该提供代码本身没有提供的信息。良好的注释是超越代码的更高层次的抽象。简单复述一眼就能从代码上看出的信息是毫无用处的注释，应尽力避免。3.1序言性注释：指每个程序或模块在开头的一段说明，对于理解程序本身具有指导作用。规范如下：a.程序的标识、名称及版本号；b.程序的功能概述；c.接口及界面描述，包括调用关系、调用形式、参数含义及相互调用的程序名；d.输入/输出数据说明，重要变量和参数的说明；a.