VB代码规范.doc
文本预览下载声明
长沙XXXXXX有限公司
软件开发标准 编号:YH-Q- 页号:1/13 版次:A 第0次修改 标题:
Visual Basic 编码标准 文件起草部门 研发部 批 准 人 批 准 日 期 2008.5.8
第一章 命名约定 2
第二章 代码布局格式约定 3
第三章 类型使用约定 4
第四章 表达式约定 4
第五章 控制结构约定 4
第六章 函数及操作符使用约定 4
第七章 模块及访问约定 4
第八章 注释使用约定 5
第九章 错误处理约定 5
第十章 其它 6
命名约定
虽然在VB中对字母大小写不敏感,本规定要求在程序设计编码过程中,一律按字母大小写敏感处理。
一律采用变量强制声明,即在“选项”对话框的“编辑器”标签中,复选“要求
变量声明”选项。Option Explicit 语句要求在 Visual Basic 程序中声明所有的变量。
变量名命名约定
3.1.变量名应符合Visual Basic的基本变量名命名规定。
它们必须以字母开头。
它们不可以包含嵌入的句号或者类型声明字符(规定数据类型的特殊字 符)。
它们不能超过 255 个字符。控件、窗体、类和模块的名字不能超过 40 个字符。
它们不能和受到限制的关键字同名。
3.2.变量名的定义应有意义,一律使用英文字母进行拼写,不用汉语拼音。
变量名=[作用域]_[类型][修饰词][名词]
3.3.变量名使用混合大小写,并以小写字母开头。
如:Dim nTemp As Long
3.4.如果变量名使用多个单词,将修饰词放在前面,并且尽量拼写完整增加可
读性。如:maxElement,currentFile 等。
3.5.变量名大小应至少2~3个字母。(当作为循环变量时,可以使用单个字母。
如:i,j,k等。)
3.6.变量名中应有其类型的修饰前缀。 下表列出一些类型修饰前缀,其它依次类推。
子类型 前缀 示例 Boolean b bFound Byte byt bytRasterData Date(Time) dt dtmStart Double dbl dblTolerance Error err errOrderNum Integer n intQuantity Long n lngDistance Object obj objCurrent Single sng sngAverage Variant var varMyData String str strFirstName Currency crr crrTotal
3.7.变量生存期(作用域)前缀的使用按下表所示。
范围 前缀 例子 全局 g_ g_strUserName 模块级 m_ m_bCalcInProgress 本地到过程 无 dblVelocity
3.8.尽量不使用Variant类型变量。
3.9.对于用户定义类型,应给每种类型一个它自己的三个字符的前缀。并且这
些前缀是以 u 开始的,例如,ucli 可以被用来作为一个用户定义的客
户类型变量的前缀。
3.10.常量名全部使用大写,当常量名是用多个单词表示时单词之间应用下划线
连起来。如:BUFFER_SIZE,FILE_SIZE 等。
4.对象名命名约定
4.1.所有对象名必须以小写字母开头,其后每一个单词都以大写字母开头
如:dlgFileOpen,mnuFileOpen。
4.2.应该用一致的前缀来命名对象,使人们容易识别对象的类型。
附件1列出了Visual Basic 支持的一些推荐使用的控件对象前缀。
附件2列出了Visual Basic 支持的推荐使用的数据访问对象 (DAO) 的
前缀。
对于表中没有列出的对象依次类推。5.函数名或过程名命名约定
5.1.所有函数名或过程名必须以大写字母开头,尽量采用组合词表示其功能
而且,函数名应该以一个动词起首。 如:?CloseDialog,GetValue.
5.2.对于函数名来说,最好能在其名字中包含其返回的类型。 如:IsEmpty返回类型是布尔值(Boolean)。
代码布局格式约定
语句块之间至少空一行。
同一层的语句应对齐。
下一层的语句应缩进四个空格。
一行只做一件事情
显示全部