程序开发规范.doc

程序开发规范一、总体要求1、必须严格执行本规范以确保源代码的可读性及可维护性。2、所有的程序文件都必须有注释文字，并严格按照本规范中的“注释规范”书写。二、命名规范 1.1 概述1、必须使用语标准英文单词，不允许使用中文拼音。2、如果有名词，必须使用单数形式。3、使用大小写混合格式，将连接的几个单词首字母大写。4、必须在3至30个字母以内。5、如果使用缩写，必须使用本规范附录的缩写范例。 1.2 文件命名规范1、文件命名采用主谓结构，首字母大写。2、文件和文件夹的名称应该精确地说明它们的用途。 1.3 函数命名规范1、函数名和方法名以动词开始，首字母大写，如 SaveFileLog。2、在命名函数时包括返回值的说明，如 GetFileName。3、类名和属性名以名词开始，首字母大写，如 EmployeeName。4、在不同的类中的属性，如果它们有相同的作用，则必须使用同样的名称。 1.4 变量命名规范1、所有变量都必须有前缀，前缀使用24个字母，全部小写。2、避免与数据字典中的数据元素名相同。3、避免与函数名、方法名、类名和属性名相同。4、避免使变量名为另一个变量名的一部分。5、布尔变量名应该包含 Is，如 blnFileIsFound。 1.5 常量命名规范1、常量所有字母都应该大写，单词之间用下划线连接。三、注释规范 2.1 概述1、注释必须使用中文及中文的标点符号。2、每行注释的最大长度为100个字符。3、将注释与注释分隔符用一个空格分开。4、不允许给注释加外框。5、编码的同时书写注释。6、重要变量必须有注释。7、变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个Tab键。8、典型算法必须有注释。9、在循环和逻辑分支的地方必须写上注释。10、程序段或语句的注释在程序段或语句的上一行。11、在代码交付之前，必须删掉临时的或无关的注释。 2.2 文件与函数的注释1、文件和函数的头部都必须有概述注释信息。2、文件和函数的概述注释应缩进1个空格。3、文件概述注释信息必须包括以下内容：(1) 文件名(2) 属性(3) 创建人(4) 创建日期4、函数概述注释信息必须包括以下内容：(1) 功能(2) 输入参数，标明意义和类型(3) 返回值，标明意义和类型(4) 作者(5) 日期四、程序书写格式 3.1 空格、空行与缩进1、在操作符的前后必须使用空格。2、在分隔数组下标和函数参数的逗号后面必须添上空格。3、一个程序段上下必须使用空行。4、变量定义部分与程序语句之间必须使用空行。5、利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab键为4个空格字符。6、以下情况使用缩进：(1) Function - End Function(2) Sub - End Sub(3) Do While - Loop(4) If - Else - End If(5) Select Case - End Select(6) For - Next 3.2 SQL语句书写规范1、写SQL语句时，关键字必须使用大写（如SELECT、WHERE等）， 数据元素（表、字段、视图等）必须按照数据字典书写；2、把每个SQL子语句分开放在不同的行中。 3.3 其它规范1、不允许使用纯粹的不带语意的数字或字符串。比如：for index=1 to 7； 而应该使用定义过的常量，比如：for index=1 to NUM_DAYS_IN_WEEK。五 编程准则 4.1 变量使用规范1、不允许随意定义全局变量。2、一个变量只能有一个用途；变量的用途必须和变量的名称保持一致。 3、所有变量都必须在类和函数最前面定义，并分类排列。 4.2 数据库操作规范1、查找数据库表或视图时，只能取出确实需要的那些字段。2、使用无关子查询，而不要使用关联子查询。3、清楚明白地使用列名，而不能使用列的序号。 4.3 对象使用规范1、尽可能晚地创建对象，并且尽可能早地释放它。 4.4 模块设计原则1、不允许随意定义公用的函数和类。2、函数功能单一，不允许一个函数实现两个及两个以上的功能。3、不能在函数内部使用全局变量，如要使用全局变量，应转化为局部变量。4、函数与函数之间只允许存在包含关系，而不允许存在交叉关系。 即两者之间只存在单方向的调用与被调用，不存在双向的调用与被调用。附1：主要名词/动词汉英对照表附件Attach一览List详细Detail编辑Edit修改Modify变更Alter附2：缩写标准 常用缩写addr address（地址）arrarray（数组）BGbackground（背景）catecategory（种类）corpcorporation(公司)Func function（函数）govgovernment（政府）imgimage(图像)incinclude(包括、包含)Infoinformation（信息）MaxMinimum（最小值）MinMaximum（最大值）Msgmessage（消息）Num Number(数目)NoNumber(号码)picpicture（图画）projproject（工程）pwdpassword（密码、口令）subjsubject（主题）syssystem（系统）前缀缩写 1、类型前缀类型名称缩写示例booleanblnblnFoundbytebytbytRasterDatadatetimedtmdtmStartdoubledbldblToleranceerrorerrerrOrderNumintegerintintQuantitylonglnglngDistanceobjectobjobjCurrentsinglesngsngAveragestringstrstrFirstNamedatasetdsdatatabledtdatarowdr2、控件前缀控件名缩写示例下拉