2024年4月12日发(作者:)

Visual Basic应用软件开发规范 网址 木瓜软件工作室

附录1 Visual Basic应用软件开发规范

Visual Basic应用软件开发规范的目的,是使应用程序的结构和编码风格标准化,以便于阅读和理

解,使代码更健壮,同时易于后期维护。

本开发规范主要规定了编写Visual Basic应用程序时,在命名约定、代码格式、代码注释、错误

处理和界面设计方面的规范。这些规范不是一成不变的,我们也不可能样样都要标准化,但保持原则上

的代码结构清晰,便于自己和他人的阅读理解,就足够了。

1.1 命名约定

1、变量命名约定

(1)变量应该被定义在尽可能小的范围内。全局(Public)变量可以导致极其复杂的状态,并且使

一个应用程序的逻辑非常难于理解。全局变量也使代码的重用和维护更加困难。

范围

过程级

模块级

全局

声明位置

过程、子过程或函数过程中的Private、Dim

窗体或代码模块(frm、bas)的声明部分中的 Private、Dim

代码模块(bas)的声明部分中的 Public

可见位置(引用位置)

在声明它的过程中

窗体或代码模块中的每一个过程

应用程序中的每一处

(2)随着工程大小的增长,划分变量范围的工作也迅速增加。在类型前缀的前面放置单字母范围前

缀标明了这种增长,但变量名的长度并没有增加很多。如果一个变量在标准模块或窗体模块中被声明为

Public,那么该变量具有全局范围。如果一个变量在标准模块或窗体模块中被分别声明为 Private,那

么该变量有模块级范围。此用法一般用在大型程序中。

范围

过程级

模块级

全局

前缀

m

g

示例

dblPayee

mlngProceedID

glngRollID

(3)变量数据类型,其前缀由三个字母组成,均需小写。而且前缀可以被扩展,用来指明变量范围。

变量命名一律使用前缀+用途的命名方式。

变量类型 前缀 描述

Array arr

数组

Boolean bln

布尔值

Byte byt

字节型

Currency cur

货币型

Date dat

日期型

Double dbl

双精度

Error err

错误对象

Handle hnd

句柄

Integer int

整型

Long lng

长整型

Object obj

对象

Single sng

单精度

String str

字符型

Time tim

时间

示例

arrDyna

blnFound

bytRasterData

curProduct

datStartRun

dblPayee

errLoadData

hndForm

intCounter

lngDistance

objCurrent

sngAverage

strFirstName

timEnd

网址 《Visual Basic 6.0 完全自学手册》热销中

·2·

Visual Basic应用软件开发规范 网址 木瓜软件工作室

2、控件命名约定

控件命名约定与变量命名相似,一律使用前缀+用途的命名方式。

控件类型 前缀 描述

Combobox cmb

下拉列表框

Checkbox chk

检查框

Commandbutton cmd

命令按钮

Commondialog dlg

公共对话框

DBGrid/MSHFlexGrid/DataGrid grd

网格

Frame Fra

框架

Form frm

窗体

Image img

图像

Label lab

标签

Line lin

直线

Listbox lst

列表框

ListView lv

列表视图

MaskEditBox msk

掩码编辑框

Menu mnu

菜单

Optionbutton opt

选项框

Picture pic

图片框

Report rpt

报表

Scrollbar sbr

滚动条

Shape shp

图形

StatusBar st

状态条

Timer tmr

定时器

ToolBar tb

工具条

Textbox txt

文本框

TreeView tv

树型视图

说明:对于上面没有列出的控件,应该用唯一的由两个或三个字符组成的前缀使它们标准化,以保

持一致性。只有当需要澄清时,才使用多于三个字符的前缀。例如,对于派生的或定制的控件象上述那

样扩展其前缀,使得在真正使用了哪一个控件的问题上避免混淆。

3、数据库对象命名约定

数据库对象命名约定与变量命名相似,一律使用前缀+用途的命名方式。

数据库对象

Container

Database

DBEngine

Document

Field

Group

Index

Parameter

QueryDef

Recordset

Relation

TableDef

User

Workspace

前缀

con

db

dbe

doc

fld

grp

ix

prm

qry

rec

rel

tbd

usr

wsp

示例

conReports

dbAccounts

dbeJet

docSalesReport

fldAddress

grpFinance

idxAge

prmJobCode

qrySalesByRegion

recForecast

relEmployeeDept

tbdCustomers

usrNew

wspMine

4、常量命名约定

网址 《Visual Basic 6.0 完全自学手册》热销中

Visual Basic应用软件开发规范 网址 木瓜软件工作室

常量名建议全部大写,

使用下划线作为单词间的分隔符,单词尽量使用全名称

·3·

对于常量名,应遵循与变量相同的约定,并加上Const关键字。如果是全局常量,应该使用Public

而不是早期版本的Global来声明变量,对一些常用词应该使用简写。

Public Const SC_CLOSE = &HF060

Public Const SC_MINIMIZE = &HF020

Public Const SC_MAXIMIZE = &HF030

5、函数命名约定

此处函数包括Sub和Function,以下将这两种过程统称为函数。

函数表示的是一个动作,所以它的结构应该是动词+名词,动词必须小写,后面的名称首字母大写,

如:

getRollInfoState

loadProceedPayeeData

setUserPass

函数命名尽量不要使用缩写,而且它的名称应该使人一目了然,必须能够反映函数的作用,能够从名

称就知道这个函数的功能,不要使用无意义的函数名称,如:getCode,readData。

另外,函数命名必须能准确表达所要实现的功能,不至于引起歧义。当函数名称不足以表达其功能

时,使用在函数头部加上让调用者足够明白的注释。

参数的命名:参数命名的原则是全部小写,如果参数包括两个或以上的单词时,首单词字母小写,

其它单词首字母大定,如showRows、isUpdate。

1.2 代码格式

1、代码格式目的

对代码进行格式化时,所要达到的目的: