转载:
必须打开设置选项的“要求变量声明”,“对齐控件到网格”,“自动缩进”开关。
Tab
的宽度统一为
4
个空格,网格单位一律设为:
width 60 height 60
。
(
注意:在任何时候,不能使用中文及全角字符,只允许使用英文字母、下划线和数字
)
ActiveX
控件和
DLL
工程命名格式为
(….Lib)
,
EXE
工程直接命名,如果是通用组件工程,直接命名,如果是项目或产品工程,则使用项目或产品缩写作为前缀。如:
XWY….Lib
。
工程命名不必缩写,为了表达意思和用途,可以尽可能地长,而且命名格式采用
(
名词
)
、
(
形容词
+
名词
)
或
(
名词
+
动作的名词形式
)
。如
: StockOperationLib
或
StockLib
。
程序中的变量遵循匈牙利表示法,即“前缀
+
变量含义”,变量的含义为一个或多个英文单词,每个单词的第一个字母大写。变量前缀为三个小写字母示意其类型,所需添加的前缀遵循微软在
MSDN
中的建议。列表如下:
对于一般的计数器变量定义,应该尽可能地简单
,如:
Dim i As Integer
For i = 0 to 100
Next i
范围标识:
全局变量加前缀:
’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
|
控件命名一律使用
控件类型缩写
+
控件用途
的命名方式,缩写规则同变量命名,以下是常用控件的类型缩写,应该严格遵守。如果使用了新的控件(包括升级版本),必须向公司提出申请,经评审通过后,协同一致其类型名称缩写,再进行使用。
控件类型前缀列表
控件
|
前缀
|
举例
|
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
|
|
|
|
此处函数包括
sub
和
function
,以下这两种过程统称为函数。
函数表示的是一个动作,所以它的结构应该是
动词
+
名词
,动词必须小写,后面的名称首字母大写,如:
getMaterialCode
updateGrid
readOrder
函数命名尽量不要使用缩写,而且它的名称应该使人一目了然,能够从名称就知道这个函数的功能,不要使用无意义的函数名称,如:
getCode
,
update
,
readData
。
当函数名称不足以表达其功能时,使用在函数头部加上让调用者足够明白的注释。
参数的命名:参数命名的原则是全部小写,如果参数包括两个或以上的单词时,首单词字母小写,其它单词首字母大写,如
showCol
、
isUpdate
。
常量的命名应该全部大写,使用‘
_
’作为单词间的分隔符,单词尽量使用全名称,如:
Public Const MSG_EMPTY_ROW As String = “
有空行存在!
”
解释:
(
1
)
对一些常用词应该使用简写,如
MSG
(
2
)
使用
Public
来声明常量
(
3
)
对常量的声明必须带上类型,如上面的
As String
属性的命名采用首字母大写的原则,如
ItemCount Item
类的命名:
Cls
前缀
+
功能名词,并且单词首字母大写。如:
ClsSystemConfig
窗体命名:使用
Frm
前缀
+
功能名词,并且单词首字母大写。如:
FrmList
。
模块命名:
Mod
前缀
+
功能名词,并且单词首字母大写。如
ModList
。
以上三种命名在一个项目内必须保持唯一。
自定义控件的命名:名词
+ Ctrl
如:
EditGridCtrl
定义的代码块应该放在一起,不要在中间定义变量,变量的定义应该顶行进齐,不能缩进。
如下:
Dim i As Integer
Dim j As Integer
Dim em As EntityManager
对象的定义应该尽可能地带上所属的库名称,防止以后引起名称冲突,如引用了两个
Lib
,每个中都包含一个
stock
类,如果不使用
As ….Lib.Stock
的定义方式,则无法编译通过,为了防止以后程序扩充和修改时引入新的库带来命名冲突,推荐在定义类对象时全部加上库标识,如:
Dim em As ObjectPersistenceLib.EntityManager
空行是区分代码块与块的间隔,在函数之间必须加上空行(两行左右),而函数内部,变量声明块和实现块(实现块指除变量声明外的其它代码)要使用空行来间隔(一行),实现块的内部,通过空行来标识一个功能段,如:
Private Sub Check(Order As NYSaleBackLib.Order)
'
减少库存
Dim objStockItem As NYStockLib.StockItem
Dim objStock As NYStockLib.Stock
Dim 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
(
注意:不要使用过多的空行,空行太多影响代码阅读!
)
缩进必须严格执行,变量声明块不缩进,实现块必须保证全部缩进(即不可能有实现块是行首对齐的)。
每个单位的代码缩进为一个
TAB
,非相关代码留一行空白的间隔。
注:
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)
程序的注译越详尽,越仔细越好。
程序中声明的每一个变量,能加上注译最好,至少用来运算或者保存关键数据的变量必须加上注译。
对于每一段逻辑上实现某个基本功能的几句代码,最好在其上一行加上简单注译。
对于每一个自定义的函数,不管大小都必须加上注译。
注译的格式如下:
'******************************************************
'
'
函数所实现的功能
'
函数的参数
1
的含义:
XXXXX
'
函数的参数
2
的含义:
XXXXX
'……
'
函数返回值所代表的错误信息:
XXXXX
'
函数的返回值为
0
表示执行成功,为其它值表示执行失败
'
'******************************************************
Public(Private) Function ForExample(……………………) As Long
'…………………………………………
End Function
在每个代码模块(窗体、类、模块、控件)的最上面,
必须
写上代码编写人、代码创建时间、代码修改时间和修改说明。
示例:
'
'
库存修改窗体
'
作者
XXXXXX
'
建立日期
2005-6-22
'
修改日期
2005-6-23
修改人
XXXXXX
'
增加对库存修改时同时影响最后入库日期的功能
2.
同一个程序在一台机器同时只能运行一次,既不能同时运行同一个程序的多个副本。
即
If App.PrevInstance = True Then End
3.
同一个登录用户同时只能登录同一个系统一次。
这样做可以减少一些数据溢出的错误,而且,在
Win32
位平台上,
CPU
处理
32
位的数据比
16
位的数据速度更快。
下面例子用
+
运算符来连接可能会导致问题。例如:
vntVar1 = "10.01"
vntVar2 = 11
vntResult = vntVar1 + vntVar2
'vntResult = 21.01
vntResult = vntVar1 & vntVar2
'vntResult = 10.0111
当显示一个消息框
(MsgBox)
或输入框
(InputBox)
,或产生一个
SQL
字符串时,这一技术特别有用。例如:
Dim Msg As String
Msg = "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 String
QRY = "SELECT *" _
& " FROM Titles" _
& " WHERE [Year Published] > 1988"
TitlesQry.SQL = QRY
CBool(expression)
CByte(expression)
CCur(expression)
CDate(expression)
CDbl(expression)
CDec(expression)
CInt(expression)
CLng(expression)
CSng(expression)
CStr(expression)
CVar(expression)
Val
(
expression
)
在
Main()
函数或主窗体
Load
过程中添加如下代码:
'******************************************************
'
'
打开错误日志文件,在
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
窗体内各个控件的布局,建议如下:
1
、所有与窗体上、下、左、右四条边界相邻的控件与窗体的边缘相距
120
缇
2
、各个控件之间的间距为:相关控件
60
缇,非相关控件
120
缇
4
、各个控件的字体建议为宋体五号字