vb编程规范匈牙利命名法.doc
《vb编程规范匈牙利命名法.doc》由会员分享，可在线阅读，更多相关《vb编程规范匈牙利命名法.doc（9页珍藏版）》请在冰点文库上搜索。
VisualBasic编程规范
编程规范注重于程序的物理结构和外观，而不是程序的逻辑结构。
使用统一编码约定集合的主要原因，是使应用程序的结构和编码风格标准化，使之容易阅读、容易理解而且容易维护。
1. VisualBasicIDE（集成开发环境）设置
必须打开设置选项的“要求变量声明”，“对齐控件到网格”，“自动缩进”开关。
Tab的宽度统一为4个空格，网格单位一律设为：
width60height60。
2. 命名约定
在任何时候，不能使用中文及全角字符，只允许使用英文字母、下划线和数字。
2.1工程的命名
ActiveX控件和DLL工程命名格式为（.Lib），EXE工程直接命名，如果是通用组件工程，直接命名，如果是项目或产品工程，则使用项目或产品缩写作为前缀。
如：
XWY.Lib。
工程命名不必缩写，为了表达意思和用途，可以尽可能地长，而且命名格式采用（名词）、（形容词+名词）或（名词+动作的名词形式）。
如:
StockOperationLib或StockLib。
2.2变量的命名
程序中的变量遵循匈牙利表示法，即“前缀+变量含义”，变量的含义为一个或多个英文单词，每个单词的第一个字母大写。
变量前缀为三个小写字母示意其类型，所需添加的前缀遵循微软在MSDN中的建议。
列表如下：
对于一般的计数器变量定义，应该尽可能地简单，如：
DimiAsInteger
Fori=0to100
Nexti
范围标识：
全局变量加前缀’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-definedtype
udt
udtEmployee
Variant（includingDates）
vnt
vntDateHired
Array
arr
arrEmployees
表二数据库对象前缀列表
数据库对象
前缀
示例
Database
dbs
dbsAccounts
Recordset
rec
recForecast
command
cmd
cmdQuery
connection
con
conSql
2.3 控件的命名
控件命名一律使用控件类型缩写+控件用途的命名方式，缩写规则同变量命名，以下是常用控件的类型缩写，应该严格遵守。
如果使用了新的控件（包括升级版本），必须向公司提出申请，经评审通过后，协同一致其类型名称缩写，再进行使用。
表三控件类型前缀列表
控件
前缀
举例
ADOData
ado
adoBiblio
Animatedbutton
ani
aniMailBox
Checkbox
chk
chkPrint
Combobox
cbo
cboTitle
Commandbutton
cmd
cmdCancel
Communications
com
comFax
Data
dat
datBiblio
Data-boundcombobox
dbcbo
dbcboLanguage
Data-boundgrid
dbgrd
dbgrdQueryResult
Commondialogcontrol
dlg
dlgCommon
Control
ctr
ctrCurrent
Directorylistbox
dir
dirSource
Drivelistbox
drv
drvTarget
DTPicker DropDateControl
dt
EnumEditBox
enm
Filelistbox
fil
filSource
Frame
fra
fraLanguage
Form
frm
frmMain
Vfgrid
grd
Graph
gra
Grouppushbutton
gpb
gpbChannel
Hierarchicalflexgrid
flex
flexOrders
Horizontalscrollbar
hsb
hsbVolume
Image
img
imgIcon
ImageImageList
img
Label
lbl
lblHelpMessage
Line
lin
linVertical
Listbox
lst
lstResultCodes
ListView
lv
MCI
mci
mciVideo
MDIchildform
mdi
mdiContact
Menucontrol
mnu
mnuFileOpen
NumEditBox
nm
OLEcontainer
ole
olePhoto
Optionbutton
opt
optSpanish
Panel
pnl
pnlSettings
Picturebox
pic
PicDiskSpace
Pictureclip
clp
ClpToolbar
ProgressBar
prg
prgLoadFile
Report
rpt
Scrollbar
sbr
Shape
shp
ShpCircle
Slider
sld
sldScale
Spin
spn
StatusBar
st
ToolBar
tb
Textbox
txt
TxtAddress
Timer
tmr
TmrAlarm
TreeView
tv
tvFlbm
Verticalscrollbar
vsb
vsbRate
2.4 函数和过程的命名
此处函数包括sub和function，以下这两种过程统称为函数。
函数表示的是一个动作，所以它的结构应该是动词+名词，动词必须小写，后面的名称首字母大写，如：
getMaterialCode、updateGrid、readOrder
函数命名尽量不要使用缩写，而且它的名称应该使人一目了然，能够从名称就知道这个函数的功能，不要使用无意义的函数名称，如：
getCode，update，readData。
当函数名称不足以表达其功能时，使用在函数头部加上让调用者足够明白的注释。
参数的命名：
参数命名的原则是全部小写，如果参数包括两个或以上的单词时，首单词字母小写，其它单词首字母大写，如showCol、isUpdate。
2.5 常量的命名
常量的命名应该全部大写，使用‘_’作为单词间的分隔符，单词尽量使用全名称，如：
PublicConstMSG_EMPTY_ROWAsString=“有空行存在！
”
解释：
（1） 对一些常用词应该使用简写，如MSG
（2） 使用Public来声明常量
（3） 对常量的声明必须带上类型，如上面的AsString
2.6 属性的命名
属性的命名采用首字母大写的原则，如ItemCount.Item
2.7 类、窗体和模块的命名
类、窗体和模块命名采用前缀+功能名词，并且单词首字母大写。
类的前缀为（Cls），如：
ClsSystemConfig；窗体前缀Frm，如：
FrmList；模块前缀为Mod，如ModList。
以上三种命名在一个项目内必须保持唯一。
2.8 自定义控件的命名
自定义控件的命名：
名词+Ctrl如：
EditGridCtrl
3. 书写格式约定
3.1 定义
定义的代码块应该放在一起，不要在中间定义变量，变量的定义应该顶行进齐，不能缩进。
如下：
DimiAsInteger
DimjAsInteger
DimemAsEntityManager
3.2 空行
空行是区分代码块与块的间隔，在函数之间必须加上空行（两行左右），而函数内部，变量声明块和实现块（实现块指除变量声明外的其它代码）要使用空行来间隔（一行），实现块的内部，通过空行来标识一个功能段，如：
PrivateSubCheck（OrderAsNYSaleBackLib.Order）'减少库存
DimobjStockItemAsNYStockLib.StockItem
DimobjStockAsNYStockLib.Stock
DimiAsInteger
SetobjStock=CreateStock（）
Fori=0ToOrder.ItemCount-1
SetobjStockItem=Order.item（i） '减少库存
CallobjStock.ReduceItem（objStockItem,True）
Nexti
SetobjStock=Nothing
EndSub
（注意：
不要使用过多的空行，空行太多影响代码阅读！
）
3.3 缩进
缩进必须严格执行，变量声明块不缩进，实现块必须保证全部缩进（即不可能有实现块是行首对齐的）。
每个单位的代码缩进为一个TAB，非相关代码留一行空白的间隔。
注：
Goto标签不缩进。
对于基本的控制结构，必须要有缩进，如：
IF、DO、WITH、FOR、OPEN、SELECT块，缩进示例如下：
PrivateFunctionGetMax（ByreflngArray（）AsLong）AsLong
DimlngMaxAsLong
DimlngCountaslong
GetMax=0
ForlngCount=0toUbound（lngArray）
IflngArray（lngCount）>lngMaxThen
lngMax=lngArray（lngCount）
EndIf
Next
EndFunction
对于过长的语句，必须使用续行，续行位置要有明显意义，示例：
sql=“SELECTcode,nameFROMPerson“_
&“WHEREcodeLIKE‘001%’“
&“andcodeLIKE‘002%’“
函数的参数如果过长，也应该续行，示例：
'
'增加库存
'ProductCode产品编号
'Spec长度规格
'Color颜色
'Patch是否拼圈
'Volumn盘号
'Ordinal子库存顺序号
'Length长度
'IsCheck是否审核入库增加（否则为弃审出库增加）
PublicSubAddDetail（ProductCodeAsString,_
SpecAsDouble,_
ColorAsString,_
PatchAsBoolean,_
VolumnAsString,_
OrdinalAsInteger,_
LengthAsDouble,_
IsCheckAsBoolean）
4. 注释约定
4.1 注释量
程序的注译越详尽，越仔细越好。
程序中声明的每一个变量，能加上注译最好，至少用来运算或者保存关键数据的变量必须加上注译。
对于每一段逻辑上实现某个基本功能的几句代码，最好在其上一行加上简单注译。
对于每一个自定义的函数，不管大小都必须加上注译。
4.2 格式
注译的格式如下：
'******************************************************
'
'函数所实现的功能
'函数的参数1的含义：
XXXXX
'函数的参数2的含义：
XXXXX
'……
'函数返回值所代表的错误信息：
XXXXX
'函数的返回值为0表示执行成功，为其它值表示执行失败
'
'******************************************************
Public（Private）FunctionForExample（……………………）AsLong
'…………………………………………
EndFunction
在每个代码模块（窗体、类、模块、控件）的最上面，必须写上代码编写人、代码创建时间、代码修改时间和修改说明。
示例：
'
'库存修改窗体
'作者 XXXXXX
'建立日期 2009-6-22
'修改日期 2009-6-23修改人XXXXXX
'增加对库存修改时同时影响最后入库日期的功能
5. 程序设计约定
1. 程序一律从Main（）函数开始执行。
2. 同一个程序在一台机器同时只能运行一次，既不能同时运行同一个程序的多个副本。
即IfApp.PrevInstance=TrueThenEnd
3. 同一个登录用户同时只能登录同一个系统一次。
4. 建议使用Long型的变量来代替Integer类型。
这样做可以减少一些数据溢出的错误，而且，在Win32位平台上，CPU处理32位的数据比16位的数据速度更快。
5. 在连接字符串时使用&运算符，避免使用＋运算符。
下面例子用＋运算符来连接可能会导致问题。
例如：
vntVar1="10.01"
vntVar2=11
vntResult=vntVar1+vntVar2'vntResult=21.01
vntResult=vntVar1&vntVar2'vntResult=10.0111
6. 当产生长字符串时，使用下划线连接字符产生多行代码，这样便于阅读或调试字符串。
当显示一个消息框（MsgBox）或输入框（InputBox），或产生一个SQL字符串时，这一技术特别有用。
例如：
DimMsgAsString
Msg="Thisisaparagraphthatwillbe"_
&"inamessagebox.Thetextis"_
&"brokenintoseverallinesofcode"_
&"inthesourcecode,makingiteasier"_
&"fortheprogrammertoreadanddebug."
MsgBoxMsg
DimQRYAsString
QRY="SELECT*"_
&"FROMTitles"_
&"WHERE[YearPublished]>1988"
TitlesQry.SQL=QRY
7. 不要将类型转换的工作交给VB自动去做，而使用以下类型转换函数。
CBool（expression）、CByte（expression）、CCur（expression）、CDate（expression）、CDbl（expression） 、CDec（expression、CInt（expression） 、CLng（expression）、CSng（expression）、CStr（expression） 、CVar（expression）、Val（expression）。
8. 编一个函数处理所有已知错误
在Main（）函数或主窗体Load过程中添加如下代码：
'******************************************************
'
'打开错误日志文件，在Form_Unload（）中关闭
'
'******************************************************
DimstrExePathAsString
IfRight（App.Path,1）="\"Then
strExePath=App.Path
Else
strExePath=App.Path&"\"
EndIf
intErrLogFileHandle=FreeFile（）
OpenstrExePath+"Err.log"ForAppendSharedAsintErrLogFileHandle
在主窗体退出函数中添加如下代码：
'******************************************************
'
'关闭错误日志文件
'
'******************************************************
Close#intErrLogFileHandle
在某个Module中添加：
'******************************************************
'
'写入错误日志
'
'******************************************************
PublicSubWriteErrLogFile（ByValstrSubAsString,ByValstrErrAsString）
Print#intErrLogFileHandle,Date,Time,strSub,strErr
EndSub
在每个过程或自定义的函数中，使用如下的系统错误捕获机制：
PublicFunctionForExample（…………）AsLong
OnErrorGotoFuncError
ForExample=True
………………………
………………………
ExitFunction
FuncError:
ForExample=False
WriteErrLogFile"ForExample","错误号：
"&Err.Number&"，错误源：
"&Err.Source&"，错误描述：
"&Err.Description
MsgBox "………",vbCritical
'在此作内存资源回收工作
EndFunction
9. 窗体布局
窗体内各个控件的布局，建议如下：
l所有与窗体上、下、左、右四条边界相邻的控件与窗体的边缘相距120缇
l各个控件之间的间距为：
相关控件60缇，非相关控件120缇
l按钮控件大小为高300缇，长〉=1200缇，这也是操作系统默认按钮的大小
l各个控件的字体建议为宋体五号字
升级会员 