黑压压的黄山岗:vb 程序编程规范

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

命名
     工程
       ActiveX控件和DLL工程命名格式为(….Lib)，EXE工程直接命名，如果是通用组件工程，直接命名，如果是项目或产品工程，则使用项目或产品缩写作为前缀。如：XWY….Lib。

       工程命名不必缩写，为了表达意思和用途，可以尽可能地长，而且命名格式采用 (名词) 、 (形容词 + 名词) 或 (名词 + 动作的名词形式)。如:XWYStockOperationLib或XWYStockLib。

       (注意：在任何时候，不要使用中文命名，包括文件夹，文件名，函数名，变量名。除非文件需要和用户交互！)

     变量
       变量命名不推荐采用匈牙利命名法，除非命名会和关键字产生冲突的时候，才采用类型缩写+变量实名的匈牙利命名法。一般情况下，变量命名应该简单，尽量使用缩写。

       如果是一般的值类型，如integer string，则直接使用变量用途命名，尽量使用全名：

       Dim name              As String

       Dim count              As Interger

       对于一般的临时性变量定义，应该尽可能地简单，如：

       Dim i                    As Integer

       For i = 0 to 100

       Next I

       如果是类对象或自定义类型对象，则在单一使用情况下使用类名称或自定义类型名称的简写来命名：

Dim em                 As EnityManager

如果非单一使用，则使用类型名称缩写为前缀，即使用匈牙利命名法：

Dim emRead          As EntityManager

Dim emSave          As EntityManager

(注意：所有前缀都全部小写，后面的单词首字母大写)

       缩写规则如下：

       如果名称由多个单词组成，则取每个单词的首字母，如EntityManager缩写为em,ProcedureManager缩写为pm。

       如果名称由一个单词组成，则对单词进行分段取首字母，如Entity缩写为et。

       缩写应该控制在3个字母以内，尽量清晰，对于接口名称，I……中的I前缀不对缩写产生任何影响，如Ientity的名称应视作Entity。

       除非首字母为元音，否则应该截取辅音做为缩写，如TextBox控件的缩写前缀为txt。

       范围标识：

              全局变量加前缀：’g_’

              模块级变量加前缀：’m_’

              过程级变量不加前缀

       全局变量和模块级变量应该尽量使用全名称，不推荐使用缩写，如：g_EntityManager

     控件
       控件命名一律使用控件类型缩写+控件用途的命名方式，类型缩写应控制在3个字母以内，缩写规则同变量命名，以下是常用控件的类型缩写，应该严格遵守，如果使用了新的控件，则首先应该在小组内协同一致其类型名称缩写后再进行使用。

cmb            Combo box
chk             Checkbox
cmd          Command button
dlg              Common dialog control
dt               DTPicker         DropDateControl
enm            EnumEditBox
fra             Frame
frm            Form
gra             Graph
grd             EditGrid MSHFlexGrid FlexGrid DataGrid
img             Image ImageList
lab              Label
ln                Line
lst               List box
lv               ListView
mnu                    Menu control
nm             NumEditBox
opt             Option button
pic              Picture
rpt              Report
sbr              Scroll bar
shp             Shape
spn             Spin
st               StatusBar
tb               ToolBar
tmr             Timer
txt             Textbox
tv               TreeView

     函数
       此处函数包括sub和function，以下这两种过程统称为函数。

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

getMaterialCode
updateGrid
readOrder

       函数命名尽量不要使用缩写，而且它的名称应该使人一目了然，能够从名称就知道这个函数的功能，不要使用无意义的函数名称，如：getCode(当这个函数属于Materail类的时候，它还是有意义的)，update，readData。

       当函数名称不足以表达其功能时，使用在函数头部加上让调用者足够明白的注释。

   

       参数的命名：参数命名的原则是全部小写，如果参数包括两个或以上的单词时，首单词字母小写，其它单词首字母大定，如showCol、isUpdate。

       常量
       常量的命名应该全部大写，使用’_’作为单词间的分隔符，单词尽量使用全名称，如：

       Public Const MSG_EMPTY_ROW      As String = “有空行存在！”

     

       解释：

（1） 对一些常用词应该使用简写，如msg

（2） 使用Public而不是早期版本的global来声明变量

（3） 对常量的声明必须带上类型，如上面的As String



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



     类、窗体和模块
       类的命名使用功能名词，不必加任何前缀和后缀，并且单词首字母大写，如：SystemConfig

       窗体命名使用功能名词 + Form后缀，如：ListForm。 但对于单据的明细窗体则统一使用Detail后缀替换Form

       模块命名：不必加任何前缀和后缀，直接命名

     自定义控件
       自定义控件的命名：名词 + Ctrl


如：EditGridCtrl

格式
     定义
       定义的代码块应该放在一起，尽量不要在中间定义变量，变量的定义应该顶行进齐，不能缩进，同时要保证”As”关键字的对齐，如下：

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

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

     缩进
       缩进必须严格执行，变量声明块不缩进，实现块必须保证全部缩进（即不可能有实现块是行首对齐的）。

       对于基本的控制结构，必须要有缩进，如：IF、DO、WITH、FOR、OPEN、SELECT块，缩进示例如下：

       …..

       If ….. Then

              …..

       End If

       …..

       (注意：在任何地方，不要写ElseIf语句，转换成IF..ELSE..ENDIF结构)

     
       对于过长的语句，必须使用续行，续行位置要有明显意义，示例：

       sql = “SELECT [code],[name] FROM [Person] “ _

              & “ WHERE [code] LIKE '001%’ “



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

'**

'增加库存

'@param        ProductCode 产品编号

'@param        Spec 长度规格

'@param        Color 颜色

'@param        Patch 是否拼圈

'@param        Volumn 盘号

'@param        Ordinal 子库存顺序号

'@param        Length 长度

'@param        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）       通过函数名称表达

（2）       通过代码来表达

（3）       通过注释来表达

由上可知，注释是在代码无法充分表达函数功能时才提供，注释同样应该做到准确简洁。

     格式
       注释的格式遵循vbDocMan的写法，一般情况下使用vbDocMan的注释编辑器进行注释编写，对于显而易见的参数或函数功能可以不加注释。参数注释中参数类型可以不要。



示例：

'**

'读取单据信息

'@param        OrderID 单据号

'@param        Order 单据

Private Function ReadOrder(OrderID As String, Order As NYSaleBackLib.Order) As Boolean

End Function





       在每个代码模块（窗体、类、模块、控件）的最上面，必须写上代码编写人（使用英文名或中文拼音缩写）、代码创建时间、代码修改时间和修改说明。

示例：

'**

'库存修改类

'@writer                pureach

'@createdate        2003-11-12

'@revision             pureach       2003-11-15

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



什么是好的代码
（1）       可读性很强的代码格式，能够区分不同的代码块

（2）       清晰明了的命名，在尽可能短的名称长度下传递足够多的信息

（3）       和代码相得益彰的注释（不要让注释重复代码所能表达的信息）

（4）       变量的生存期尽可能地短，这样阅读者不用去记大量的变量声明

（5）       使用小函数，将功能复杂的大函数进行分隔





总之，代码的好坏应该让别人是否能够容易读懂来区分，如果对自己的代码不满意，那么先给别人阅读，然后让阅读者告诉你他为什么读不懂，哪些地方读着吃力。好的代码应该能够让你在几个月后回顾自己的代码时一目了然（架构的清晰是代码易读的前提）。



qqq123 发表于:2005.03.13 21:36 ::分类: ( 初始分类 ) ::阅读:(256次) :: 评论 (0)
===========================================================
VB
===========================================================
、变量和对象

    程序中的变量遵循匈牙利表示法，即“前缀+变量含义”，变量的含义为一个或多个英文单词，每个单词的第一个字母大写，不要用汉语拼音代替。变量前缀为三个小写字母示意其类型，所需添加的前缀遵循微软在MSDN中的建议。列表如下：




    基本数据类型


变量类型

前缀

示例


Boolean

bln

blnFound


Byte

byt

bytRasterData


Collection object

col

colWidgets


Currency

cur

curRevenue


Date (Time)

dtm

dtmStart


Double

dbl

dblTolerance


Error

err

errOrderNum


Integer

int

intQuantity


Long

lng

lngDistance


Object

obj

objCurrent


Single

sng

sngAverage


String

str

strFName


User-defined type

udt

udtEmployee


Variant

vnt

vntCheckSum



   


    控件或窗体、模块对象


控件类型

前缀

示例


3D Panel

pnl

pnlGroup


ADO Data

ado

adoBiblio


Animated button

ani

aniMailBox


Check box

chk

chkReadOnly


Combo box, drop-down list box

cbo

cboEnglish


Command button

cmd

cmdExit


Common dialog

dlg

dlgFileOpen


Communications

com

comFax


Control (在过程中使用的类型未明的控件变量)

ctr

ctrCurrent


Data

dat

datBiblio


Data-bound combo box

dbcbo

dbcboLanguage


Data-bound grid

dbgrd

dbgrdQueryResult


Data-bound list box

dblst

dblstJobType


Data combo

dbc

dbcAuthor


Data grid

dgd

dgdTitles


Data list

dbl

dblPublisher


Data repeater

drp

drpLocation


Date picker

dtp

dtpPublished


Directory list box

dir

dirSource


Drive list box

drv

drvTarget


File list box

fil

filSource


Flat scroll bar

fsb

fsbMove


Form

frm

frmEntry


Frame

fra

fraLanguage


Gauge

gau

gauStatus


Graph

gra

graRevenue


Grid

grd

grdPrices


Hierarchical flexgrid

flex

flexOrders


Horizontal scroll bar

hsb

hsbVolume


Image

img

imgIcon


Image combo

imgcbo

imgcboProduct


ImageList

ils

ilsAllIcons


Label

lbl

lblHelpMessage


Lightweight check box

lwchk

lwchkArchive


Lightweight combo box

lwcbo

lwcboGerman


Lightweight command button

lwcmd

lwcmdRemove


Lightweight frame

lwfra

lwfraSaveOptions


Lightweight horizontal scroll bar

lwhsb

lwhsbVolume


Lightweight list box

lwlst

lwlstCostCenters


Lightweight option button

lwopt

lwoptIncomeLevel


Lightweight text box

lwtxt

lwoptStreet


Lightweight vertical scroll bar

lwvsb

lwvsbYear


Line

lin

linVertical


List box

lst

lstPolicyCodes


ListView

lvw

lvwHeadings


MAPI message

mpm

mpmSentMessage


MAPI session

mps

mpsSession


MCI

mci

mciVideo


Menu

mnu

mnuFileOpen


Month view

mvw

mvwPeriod


MS Chart

ch

chSalesbyRegion


MS Flex grid

msg

msgClients


MS Tab

mst

mstFirst


OLE container

ole

oleWorksheet


Option button

opt

optGender


Picture box

pic

picVGA


Picture clip

clp

clpToolbar


ProgressBar

prg

prgLoadFile


Remote Data

rd

rdTitles


RichTextBox

rtf

rtfReport


Shape

shp

shpCircle


Slider

sld

sldScale


Spin

spn

spnPages


StatusBar

sta

staDateTime


SysInfo

sys

sysMonitor


TabStrip

tab

tabOptions


Text box

txt

txtLastName


Timer

tmr

tmrAlarm


Toolbar

tlb

tlbActions


TreeView

tre

treOrganization


UpDown

upd

updDirection


Vertical scroll bar

vsb

vsbRate





    数据库对象


数据库对象

前缀

示例


Container

con

conReports


Database

db

dbAccounts


DBEngine

dbe

dbeJet


Document

doc

docSalesReport


Field

fld

fldAddress


Group

grp

grpFinance


Index

ix

idxAge


Parameter

prm

prmJobCode


QueryDef

qry

qrySalesByRegion


Recordset

rec

recForecast


Relation

rel

relEmployeeDept


TableDef

tbd

tbdCustomers


User

usr

usrNew


Workspace

wsp

wspMine





    除此之外，还要对于一些不同的级别的变量加额外的前缀，举例如下：


级别

前缀

示例


全局变量

g

gstrUserName


模块级变量

m

mblnCalcInProgress


过程级变量

None

dblVelocity





    对于用户使用type关键字定义的数据类型，在三个字母的前缀前再加u。例如：一个用户定义的叫Client类型的变量，其前缀为ucli。




    关于变量使用方面，建议如下：


1、变量要先声明再使用（在窗体代码的第一行加上Option Explicit，来禁止未声明变量的调用，或者在菜单Tools->Options->Editor中选中Require Variable Declaration项。）


2、尽量使用Long型的变量来代替Integer类型，这样做可以减少一些数据溢出的错误，而且，在Win32平台上，CPU处理32位的数据比16位的数据速度更快。


3、尽量少用Variant变量，尽可能地给出每一个变量明确的类型


4、尽量不在API声明中使用As Any，如果遇到其默认的参数为As Any的情况，则针对每一个所需的参数类型声明该API函数，例如ReadFile函数默认的声明为：


Public Declare Function ReadFile Lib "kernel32" Alias "ReadFile" (ByVal hFile As Long, lpBuffer As Any, ByVal nNumberOfBytesToRead As Long, lpNumberOfBytesRead As Long, lpOverlapped As OVERLAPPED) As Long


小组成员须将其改为：


Public Declare Function ReadFileByt Lib "kernel32" Alias "ReadFile" (ByVal hFile As Long, lpBuffer As Byte, ByVal nNumberOfBytesToRead As Long, lpNumberOfBytesRead As Long, lpOverlapped As OVERLAPPED) As Long


Public Declare Function ReadFileInt Lib "kernel32" Alias "ReadFile" (ByVal hFile As Long, lpBuffer As Integer, ByVal nNumberOfBytesToRead As Long, lpNumberOfBytesRead As Long, lpOverlapped As OVERLAPPED) As Long


Public Declare Function ReadFileLng Lib "kernel32" Alias "ReadFile" (ByVal hFile As Long, lpBuffer As Long, ByVal nNumberOfBytesToRead As Long, lpNumberOfBytesRead As Long, lpOverlapped As OVERLAPPED) As Long




5、不要将类型转换的工作交给VB自动去做，而使用以下类型转换函数


CBool(expression)


CByte(expression)


CCur(expression)


CDate(expression)


CDbl(expression)


CDec(expression)


CInt(expression)


CLng(expression)


CSng(expression)


CStr(expression)


CVar(expression)




二、窗体布局


    窗体内各个控件的布局，建议如下：


    1、所有与窗体上、下、左、右四条边界相邻的控件与窗体的边缘相距120缇


    2、各个控件之间的间距为：相关控件60缇，非相关控件120缇


    3、按钮控件大小建议为高300缇，长1200缇，这也是操作系统默认按钮的大小


    4、各个控件的字体建议为宋体五号字




三、代码


    1、程序的启动对象


        程序一率从Main()函数开始执行（选择菜单View->Project Explorer，在工程窗口内右键点击当前项目，选择菜单“… Properties”->General，在Startup Object下拉框中选择sub main）


2、代码缩进与间距


        每个单位的代码缩进为一个TAB，非相关代码留一行空白的间隔，例如：


Private Function GetMax(Byref lngArray() As Long) As Long




    GetMax=0




    Dim lngMax As Long


    Dim lngCount as long




    For lngCount =0 to Ubound(lngArray)


        If lngArray (lngCount)>lngMax Then


            lngMax=lngArray(lngCount)


        End If


    Next




End Function




    3、注译


        程序的注译越详尽，越仔细越好。以下提及的，必须加注译。


        程序中声明的每一个变量，能加上注译最好，至少用来运算或者保存关键数据的变量必须加上注译。


        对于每一段逻辑上实现某个基本功能的几句代码，最好在其上一行加上简单注译。


        对于每一个自定义的函数，不管大小都必须加上注译，而且注译的格式如下：


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


'


'函数所实现的功能


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


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


'……


'函数返回值所代表的错误信息：XXXXX（函数尽可能声明为Function，不要声明为Sub，


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


'


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




Public(Private) Function ForExample(……………………) As Long


'…………………………………………


End Function




    4、错误处理（未定）


        在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