VB开发规范.doc

VB 开发规范 VB 开发规范科技有限公司 2011 年 03月 01日 VB 开发规范文档修改记录版本日期说明操作者审核者 20 10/8/ 30 2010-9-1 2011-3- 1 吴琼 VB 开发规范前言: 本规范涵盖了科技有限公司 VB 开发类项目的编码、结构等一套完整规范,是所有 VB 开发类项目的开发指导、代码审核和绩效考核依据。 1 规范级别定义?< 一级> 强制约束,发生违规现象时要求立即纠正; ?< 二级> 强制约束,发生违规现象后要求在进度计划外进行代码重构; ?< 三级> 建议型规范 2 语言基本规范 缩进 1) 在编写代码时, 必须采用按层次缩进的结构化形式, 这样可大大提高程序的可读性, 方便日后的维护。注意,层次缩进统一使用 TAB 键, 禁止使用空格。如: < 一级> Public Sub DataEdit() If rs Table Is Nothing Then MsgBox " 对象没有实例化"," 金蝶提示" Else Set f rm Edit = New FrmTableEdit Iff rm Edit .SetData(idTableRs) <1 Then MsgBox " 参数调用失败"," 金蝶提示" Set f rm Edit = Nothing Else f rm Edit .Show End If End If End Sub 换行如果一行上的代码太长,将会影响阅读的效果,必须使用‘_&’连接符将一行的长代码变成多行, 以便于阅读和调试程序。一行代码长度不超过编程窗口的 3/4 宽度。‘&’要放在句首。如: < 一级> StrSql =“ select , “_ &“ From t_Order v1,t_Customer u1“_ &“ Where >‘ 2000-1-1 ’“_ VB 开发规范&“ order by ” 注释 1. 模块注释在每个模块的头部,必须对模块实现的主要功能作说明,格式如下: < 一级> '********************************************************************************** '* 模块名称:** 功能数据录入主窗体'* 功能描述: '*作者: '* 修改时间: '*备注: '********************************************************************************** 2. 函数(属性)注释:每个函数头需要作注释,格式如下: < 一级> '************************************************************************** '功能: ' 传入参数: ' 返回参数: '作者: '日期: '************************************************************************** 3. 语句注释代码语句结尾至少一个 Tab 间隔处,直接写注释内容。在函数内,如果存在比较复杂的控制、循环处理、算法,必须作出注释说明。< 一级> 4. 变量、常量定义注释声明语句结尾至少一个 Tab 间隔处,直接写注释内容。对全局变量、模块级变量和常量必须进行注释。< 一级> 5. 对于后续维护产生的改动,必须作出注释,注明修改人、修改时间、修改内容,并且把原来的代码注释掉,不能删除。< 一级> 命名 变量命名变量命名格式:类型前缀+ 变量含义,其中变量含义需要使用英文单词, 前缀全部小写, 变量含义首字母大写。一个变量只能有一个用途,变量的用途必须和变量的名称保持一致。< 一级> 下面为变量前缀标准列表< 一级>: 变量类型前缀示例 Boolean bb Found VB 开发规范 Byte b ytb ytRasterData Collection object c olc olWidgets Currency c urc urRevenue Date (Time) dt dt Start Double dd Tolerance Error err err OrderNum Integer ii Quantity Long ll Distance Object oo Current Single sng s ngAverage String str str FName User-defined type udt udt Employee Variant vv