visual basic编程规范

1.      visual basic ide（集成开发环境）设置

       必须打开设置选项的“要求变量声明”，“对齐控件到网格”，“自动缩进”开关。        tab的宽度统一为4个空格，网格单位一律设为：width 60 height 60。

2.     命名约定

       (注意：在任何时候，不能使用中文及全角字符，只允许使用英文字母、下划线和数字)

2.1          工程的命名

       activex控件和dll工程命名格式为(….lib)，exe工程直接命名，如果是通用组件工程，直接命名，如果是项目或产品工程，则使用项目或产品缩写作为前缀。如：xwy….lib。        工程命名不必缩写，为了表达意思和用途，可以尽可能地长，而且命名格式采用 (名词) 、 (形容词 + 名词) 或 (名词 + 动作的名词形式)。如: stockoperationlib或stocklib。

2.2          变量的命名

              全局变量加前缀：’g_’ 例如：g_strfdbm

              模块级变量加前缀：’m_’ 例如：m_strfdbm

              过程级变量不加前缀        全局变量和模块级变量应该尽量使用全名称，不推荐使用缩写，如：gentitymanager常见的变量类型和控件类型前缀如下表所示：变量类型前缀列表

数据类型

前缀

示例

boolean

bln

blnloggedin

currency

cur

cursalary

control

ctl

ctllastcontrol

double

dbl

dblmiles

errobject

err

errlasterror

single

sng

sngyears

handle

hwd

hwdpicture

long

lng

lngonhand

object

obj

objusertable

integer

int

intage

string

str

strname

user-defined type

udt

udtemployee

variant (including dates)

vnt

vntdatehired

array

arr

arremployees 数据库对象前缀示例database

dbs

dbsaccounts recordset

rec

recforecast command

cmd

cmdquery connection

con

consql

2.3          控件的命名

       控件命名一律使用控件类型缩写+控件用途的命名方式，缩写规则同变量命名，以下是常用控件的类型缩写，应该严格遵守。如果使用了新的控件（包括升级版本），必须向公司提出申请，经评审通过后，协同一致其类型名称缩写，再进行使用。 控件类型前缀列表

控件

前缀

举例

ado data

ado

adobiblio

animated button

ani

animailbox

checkbox

chk

chkprint

combo box

cbo

cbotitle

command button

cmd

cmdcancel

communications

com

comfax

data

dat

datbiblio

data-bound combo box

dbcbo

dbcbolanguage

data-bound grid

dbgrd

dbgrdqueryresult

common dialog control

dlg

dlgcommon

control

ctr

ctrcurrent

directory list box

dir

dirsource

drive list box

drv

drvtarget

dtpicker       dropdatecontrol

dt

enumeditbox

enm

file list box

fil

filsource

frame

fra

fralanguage

form

frm

frmmain

vfgrid

grd

graph

gra

group push button

gpb

gpbchannel

hierarchical flexgrid

flex

flexorders

horizontal scroll bar

hsb

hsbvolume

image

img

imgicon

image imagelist

img

label

lbl

lblhelpmessage

line

lin

linvertical

list box

lst

lstresultcodes

listview

lv

mci

mci

mcivideo

mdi child form

mdi

mdicontact

menu control

mnu

mnufileopen

numeditbox

nm

ole container

ole

olephoto

option button

opt

optspanish

panel

pnl

pnlsettings

picture box

pic

picdiskspace

picture clip

clp

clptoolbar

progressbar

prg

prgloadfile

report

rpt

scroll bar

sbr

shape

shp

shpcircle

slider

sld

sldscale

spin

spn

statusbar

st

toolbar

tb

text box

txt

txtaddress

timer

tmr

tmralarm

treeview

tv

tvflbm

vertical scroll bar

vsb

vsbrate

2.4          函数和过程的命名

       此处函数包括sub和function，以下这两种过程统称为函数。        函数表示的是一个动作，所以它的结构应该是 动词+名词，动词必须小写，后面的名称首字母大写，如：getmaterialcodeupdategridreadorder       函数命名尽量不要使用缩写，而且它的名称应该使人一目了然，能够从名称就知道这个函数的功能，不要使用无意义的函数名称，如：getcode，update，readdata。       当函数名称不足以表达其功能时，使用在函数头部加上让调用者足够明白的注释。       参数的命名：参数命名的原则是全部小写，如果参数包括两个或以上的单词时，首单词字母小写，其它单词首字母大写，如showcol、isupdate。

2.5          常量的命名

       常量的命名应该全部大写，使用‘_’作为单词间的分隔符，单词尽量使用全名称，如：        public const msg_empty_row as string = “有空行存在！”       解释：（1）  对一些常用词应该使用简写，如msg（2）  使用public来声明常量（3）  对常量的声明必须带上类型，如上面的as string

2.6          属性的命名

       属性的命名采用首字母大写的原则，如itemcount item

2.7          类、窗体和模块的命名

       类的命名：cls前缀+功能名词，并且单词首字母大写。如：clssystemconfig        窗体命名：使用frm前缀+功能名词，并且单词首字母大写。如：frmlist。        模块命名：mod前缀+功能名词，并且单词首字母大写。如modlist。以上三种命名在一个项目内必须保持唯一。

2.8          自定义控件的命名

       自定义控件的命名：名词 + ctrl 如：editgridctrl

3.     书写格式约定

3.1          定义

如下： dim i as integerdim j as integerdim em as entitymanager       对象的定义应该尽可能地带上所属的库名称，防止以后引起名称冲突，如引用了两个lib，每个中都包含一个stock类，如果不使用as ….lib.stock的定义方式，则无法编译通过，为了防止以后程序扩充和修改时引入新的库带来命名冲突，推荐在定义类对象时全部加上库标识，如：       dim em as objectpersistencelib.entitymanager

3.2          空行

       空行是区分代码块与块的间隔，在函数之间必须加上空行（两行左右），而函数内部，变量声明块和实现块（实现块指除变量声明外的其它代码）要使用空行来间隔（一行），实现块的内部，通过空行来标识一个功能段，如： private sub check(order as nysalebacklib.order)

'减少库存 dim objstockitem as nystocklib.stockitemdim objstock as nystocklib.stockdim i as integer     set objstock = createstock()     for i = 0 to order.itemcount - 1            set objstockitem = order.item(i) 

        '减少库存         call objstock.reduceitem(objstockitem, true)     next i            set objstock = nothing    end sub 

(注意：不要使用过多的空行，空行太多影响代码阅读！)

3.3          缩进

注：goto标签不缩进        对于基本的控制结构，必须要有缩进，如：if、do、with、for、open、select块，缩进示例如下：private function getmax(byref lngarray() as long) as long  dim lngmax as long  dim lngcount as long            getmax=0         for lngcount =0 to ubound(lngarray) 

         if lngarray (lngcount)>lngmax then              lngmax=lngarray(lngcount)          end if      next     end function  对于过长的语句，必须使用续行，续行位置要有明显意义，示例：       sql = “select [code],[name] from [person] “ _              & “ where [code] like ‘001%’ “              & “ and [code] like ‘002%’ “

        函数的参数如果过长，也应该续行，示例：

'

'增加库存

' productcode 产品编号

' spec 长度规格

' color 颜色

' patch 是否拼圈

' volumn 盘号

' ordinal 子库存顺序号

' length 长度

' ischeck 是否审核入库增加（否则为弃审出库增加) public sub adddetail(productcode as string, _                spec as double, _                color as string, _                patch as boolean, _                volumn as string, _                ordinal as integer, _                length as double, _                ischeck as boolean)

4.     注释约定

4.1        注释量

4.2        格式

'****************************************************** 

' 

'函数所实现的功能 

'函数的参数1的含义：xxxxx 

'函数的参数2的含义：xxxxx 

'…… 

'函数返回值所代表的错误信息：xxxxx

'函数的返回值为0表示执行成功，为其它值表示执行失败

' 

'****************************************************** public(private) function forexample(……………………) as long  '…………………………………………  end function

 在每个代码模块（窗体、类、模块、控件）的最上面，必须写上代码编写人、代码创建时间、代码修改时间和修改说明。示例：

'

'库存修改窗体

'作者             xxxxxx

'建立日期     2005-6-22

'修改日期      2005-6-23 修改人 xxxxxx

'增加对库存修改时同时影响最后入库日期的功能

5.     程序设计约定

1.      程序一律从main()函数开始执行。

2.      同一个程序在一台机器同时只能运行一次，既不能同时运行同一个程序的多个副本。

3.      同一个登录用户同时只能登录同一个系统一次。

4.      建议使用long型的变量来代替integer类型。

5.      在连接字符串时使用 & 运算符，避免使用 ＋ 运算符。

6.      当产生长字符串时，使用下划线连接字符产生多行代码，这样便于阅读或调试字符串。

 dim msg as stringmsg = "this is a paragraph that will be " _& "in a message box. the text is" _& " broken into several lines of code" _& " in the source code, making it easier" _& " for the programmer to read and debug."msgbox msg

 dim qry as stringqry = "select *" _& " from titles" _& " where [year published] > 1988"titlesqry.sql = qry

7.      不要将类型转换的工作交给vb自动去做，而使用以下类型转换函数。 

8.      错误处理（编一个函数处理所有已知错误）

'****************************************************** 

' 

'打开错误日志文件，在form_unload()中关闭 

' 

'******************************************************     dim strexepath as string 

     if right(app.path, 1) = "/" then          strexepath = app.path      else          strexepath = app.path & "/"  end if 

 interrlogfilehandle = freefile() 

 open strexepath + "err.log" for append shared as interrlogfilehandle     在主窗体退出函数中添加如下代码：  '****************************************************** 

' 

'关闭错误日志文件 

' 

'******************************************************         close #interrlogfilehandle     在某个module中添加： 

'****************************************************** 

' 

'写入错误日志 

' 

'****************************************************** 

 public sub writeerrlogfile(byval strsub as string, byval strerr as string)      print #interrlogfilehandle, date, time, strsub, strerr  end sub     在每个过程或自定义的函数中，使用如下的系统错误捕获机制：  public function forexample(…………) as long         on error goto funcerror         forexample=true         ………………………      ………………………         exit function  funcerror:      forexample=false      writeerrlogfile " forexample ", "错误号：" & err.number & "，错误源：" & err.source & "，错误描述：" & err.description      msgbox  "……… ", vbcritical 

    '在此作内存资源回收工作  end function 

9.      窗体布局