Tab的寬度統(tǒng)一為4個(gè)空格，網(wǎng)格單位一律設(shè)為:width 50 height 50。

命名

     工程

       ActiveX控件和DLL工程命名格式為(….Lib)，EXE工程直接命名，如果是通用組件工程，直接命名，如果是項(xiàng)目或產(chǎn)品工程，則使用項(xiàng)目或產(chǎn)品縮寫(xiě)作為前綴。如：XWY….Lib。

       工程命名不必縮寫(xiě)，為了表達(dá)意思和用途，可以盡可能地長(zhǎng)，而且命名格式采用 (名詞) 、 (形容詞 + 名詞) 或 (名詞 + 動(dòng)作的名詞形式)。如:XWYStockOperationLib或XWYStockLib。

       (注意：在任何時(shí)候，不要使用中文命名，包括文件夾，文件名，函數(shù)名，變量名。除非文件需要和用戶(hù)交互！)

     變量

       變量命名不推薦采用匈牙利命名法，除非命名會(huì)和關(guān)鍵字產(chǎn)生沖突的時(shí)候，才采用類(lèi)型縮寫(xiě)+變量實(shí)名的匈牙利命名法。一般情況下，變量命名應(yīng)該簡(jiǎn)單，盡量使用縮寫(xiě)。

       如果是一般的值類(lèi)型，如integer string，則直接使用變量用途命名，盡量使用全名：

       Dim name              As String

       Dim count              As Interger

       對(duì)于一般的臨時(shí)性變量定義，應(yīng)該盡可能地簡(jiǎn)單，如：

       Dim i                    As Integer

       For i = 0 to 100

       Next I

       如果是類(lèi)對(duì)象或自定義類(lèi)型對(duì)象，則在單一使用情況下使用類(lèi)名稱(chēng)或自定義類(lèi)型名稱(chēng)的簡(jiǎn)寫(xiě)來(lái)命名：

Dim em                 As EnityManager

如果非單一使用，則使用類(lèi)型名稱(chēng)縮寫(xiě)為前綴，即使用匈牙利命名法：

Dim emRead          As EntityManager

Dim emSave          As EntityManager

(注意：所有前綴都全部小寫(xiě)，后面的單詞首字母大寫(xiě))

       縮寫(xiě)規(guī)則如下：

       如果名稱(chēng)由多個(gè)單詞組成，則取每個(gè)單詞的首字母，如EntityManager縮寫(xiě)為em,ProcedureManager縮寫(xiě)為pm。

       如果名稱(chēng)由一個(gè)單詞組成，則對(duì)單詞進(jìn)行分段取首字母，如Entity縮寫(xiě)為et。

       縮寫(xiě)應(yīng)該控制在3個(gè)字母以?xún)?nèi)，盡量清晰，對(duì)于接口名稱(chēng)，I……中的I前綴不對(duì)縮寫(xiě)產(chǎn)生任何影響，如Ientity的名稱(chēng)應(yīng)視作Entity。

       除非首字母為元音，否則應(yīng)該截取輔音做為縮寫(xiě)，如TextBox控件的縮寫(xiě)前綴為txt。

       范圍標(biāo)識(shí)：

              全局變量加前綴：’g_’

              模塊級(jí)變量加前綴：’m_’

              過(guò)程級(jí)變量不加前綴

       全局變量和模塊級(jí)變量應(yīng)該盡量使用全名稱(chēng)，不推薦使用縮寫(xiě)，如：g_EntityManager

     控件

       控件命名一律使用控件類(lèi)型縮寫(xiě)+控件用途的命名方式，類(lèi)型縮寫(xiě)應(yīng)控制在3個(gè)字母以?xún)?nèi)，縮寫(xiě)規(guī)則同變量命名，以下是常用控件的類(lèi)型縮寫(xiě)，應(yīng)該嚴(yán)格遵守，如果使用了新的控件，則首先應(yīng)該在小組內(nèi)協(xié)同一致其類(lèi)型名稱(chēng)縮寫(xiě)后再進(jìn)行使用。

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

     函數(shù)

       此處函數(shù)包括sub和function，以下這兩種過(guò)程統(tǒng)稱(chēng)為函數(shù)。

       函數(shù)表示的是一個(gè)動(dòng)作，所以它的結(jié)構(gòu)應(yīng)該是 動(dòng)詞+名詞，動(dòng)詞必須小寫(xiě)，后面的名稱(chēng)首字母大寫(xiě)，如：

getMaterialCode
updateGrid
readOrder

       函數(shù)命名盡量不要使用縮寫(xiě)，而且它的名稱(chēng)應(yīng)該使人一目了然，能夠從名稱(chēng)就知道這個(gè)函數(shù)的功能，不要使用無(wú)意義的函數(shù)名稱(chēng)，如：getCode(當(dāng)這個(gè)函數(shù)屬于Materail類(lèi)的時(shí)候，它還是有意義的)，update，readData。

       當(dāng)函數(shù)名稱(chēng)不足以表達(dá)其功能時(shí)，使用在函數(shù)頭部加上讓調(diào)用者足夠明白的注釋。

       參數(shù)的命名：參數(shù)命名的原則是全部小寫(xiě)，如果參數(shù)包括兩個(gè)或以上的單詞時(shí)，首單詞字母小寫(xiě)，其它單詞首字母大定，如showCol、isUpdate。

     常量

       常量的命名應(yīng)該全部大寫(xiě)，使用’_’作為單詞間的分隔符，單詞盡量使用全名稱(chēng)，如：

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

       解釋?zhuān)?/span>

（1） 對(duì)一些常用詞應(yīng)該使用簡(jiǎn)寫(xiě)，如msg

（2） 使用Public而不是早期版本的global來(lái)聲明變量

（3） 對(duì)常量的聲明必須帶上類(lèi)型，如上面的As String

     屬性

       屬性的命名采用首字母大寫(xiě)的原則，如ItemCount Item

     類(lèi)、窗體和模塊

       類(lèi)的命名使用功能名詞，不必加任何前綴和后綴，并且單詞首字母大寫(xiě)，如：SystemConfig

       窗體命名使用功能名詞 + Form后綴，如：ListForm。 但對(duì)于單據(jù)的明細(xì)窗體則統(tǒng)一使用Detail后綴替換Form

       模塊命名：不必加任何前綴和后綴，直接命名

     自定義控件

       自定義控件的命名：名詞 + Ctrl

如：EditGridCtrl

格式

     定義

       定義的代碼塊應(yīng)該放在一起，盡量不要在中間定義變量，變量的定義應(yīng)該頂行進(jìn)齊，不能縮進(jìn)，同時(shí)要保證”As”關(guān)鍵字的對(duì)齊，如下：

Dim i             As Integer

Dim j             As Integer

Dim em          As EntityManager

       對(duì)象的定義應(yīng)該盡可能地帶上所屬的庫(kù)名稱(chēng)，防止以后引起名稱(chēng)沖突，如引用了兩個(gè)Lib，每個(gè)中都包含一個(gè)stock類(lèi)，如果不使用As ….Lib.Stock的定義方式，則無(wú)法編譯通過(guò)，為了防止以后程序擴(kuò)充和修改時(shí)引入新的庫(kù)帶來(lái)命名沖突，推薦在定義類(lèi)對(duì)象時(shí)全部加上庫(kù)標(biāo)識(shí)，對(duì)于本工程的類(lèi)對(duì)象定義也要加上，如：

       Dim em          As ObjectPersistenceLib.EntityManager

     空行

       空行是區(qū)分代碼塊與塊的間隔，在函數(shù)之間必須加上空行（兩行左右），而函數(shù)內(nèi)部，變量聲明塊和實(shí)現(xiàn)塊（實(shí)現(xiàn)塊指除變量聲明外的其它代碼）要使用空行來(lái)間隔（一行），實(shí)現(xiàn)塊的內(nèi)部，通過(guò)空行來(lái)標(biāo)識(shí)一個(gè)功能段，如：

Private Sub Check(Order As NYSaleBackLib.Order)

‘* 減少庫(kù)存

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)

        ‘* 減少庫(kù)存

        Call objStock.ReduceItem(objStockItem, True)

    Next i

    Set objStock = Nothing

End Sub

(注意：不要使用過(guò)多的空行，空行太多影響代碼閱讀！)

     縮進(jìn)

       縮進(jìn)必須嚴(yán)格執(zhí)行，變量聲明塊不縮進(jìn)，實(shí)現(xiàn)塊必須保證全部縮進(jìn)（即不可能有實(shí)現(xiàn)塊是行首對(duì)齊的）。

       對(duì)于基本的控制結(jié)構(gòu)，必須要有縮進(jìn)，如：IF、DO、WITH、FOR、OPEN、SELECT塊，縮進(jìn)示例如下：

       …..

       If ….. Then

              …..

       End If

       …..

       (注意：在任何地方，不要寫(xiě)ElseIf語(yǔ)句，轉(zhuǎn)換成IF..ELSE..ENDIF結(jié)構(gòu))

       對(duì)于過(guò)長(zhǎng)的語(yǔ)句，必須使用續(xù)行，續(xù)行位置要有明顯意義，示例：

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

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

       函數(shù)的參數(shù)如果過(guò)長(zhǎng)，也應(yīng)該續(xù)行，示例：

‘**

‘增加庫(kù)存

‘@param        ProductCode 產(chǎn)品編號(hào)

‘@param        Spec 長(zhǎng)度規(guī)格

‘@param        Color 顏色

‘@param        Patch 是否拼圈

‘@param        Volumn 盤(pán)號(hào)

‘@param        Ordinal 子庫(kù)存順序號(hào)

‘@param        Length 長(zhǎng)度

‘@param        IsCheck 是否審核入庫(kù)增加（否則為棄審出庫(kù)增加)

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)

注釋

     量

       注釋以盡可能少為宜，但必須要做到別人能夠通過(guò)閱讀你的代碼明白你的意思，讓調(diào)用者明白函數(shù)功能的表達(dá)優(yōu)先級(jí)原則如下：

（1）       通過(guò)函數(shù)名稱(chēng)表達(dá)

（2）       通過(guò)代碼來(lái)表達(dá)

（3）       通過(guò)注釋來(lái)表達(dá)

由上可知，注釋是在代碼無(wú)法充分表達(dá)函數(shù)功能時(shí)才提供，注釋同樣應(yīng)該做到準(zhǔn)確簡(jiǎn)潔。

     格式

       注釋的格式遵循vbDocMan的寫(xiě)法，一般情況下使用vbDocMan的注釋編輯器進(jìn)行注釋編寫(xiě)，對(duì)于顯而易見(jiàn)的參數(shù)或函數(shù)功能可以不加注釋。參數(shù)注釋中參數(shù)類(lèi)型可以不要。

示例：

‘**

‘讀取單據(jù)信息

‘@param        OrderID 單據(jù)號(hào)

‘@param        Order 單據(jù)

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

End Function

       在每個(gè)代碼模塊（窗體、類(lèi)、模塊、控件）的最上面，必須寫(xiě)上代碼編寫(xiě)人（使用英文名或中文拼音縮寫(xiě)）、代碼創(chuàng)建時(shí)間、代碼修改時(shí)間和修改說(shuō)明。

示例：

‘**

‘庫(kù)存修改類(lèi)

‘@writer                pureach

‘@createdate        2003-11-12

‘@revision             pureach       2003-11-15

‘增加對(duì)庫(kù)存修改時(shí)同時(shí)影響最后入庫(kù)日期的功能

什么是好的代碼

（1）       可讀性很強(qiáng)的代碼格式，能夠區(qū)分不同的代碼塊

（2）       清晰明了的命名，在盡可能短的名稱(chēng)長(zhǎng)度下傳遞足夠多的信息

（3）       和代碼相得益彰的注釋?zhuān)ú灰屪⑨屩貜?fù)代碼所能表達(dá)的信息）

（4）       變量的生存期盡可能地短，這樣閱讀者不用去記大量的變量聲明

（5）       使用小函數(shù)，將功能復(fù)雜的大函數(shù)進(jìn)行分隔

總之，代碼的好壞應(yīng)該讓別人是否能夠容易讀懂來(lái)區(qū)分，如果對(duì)自己的代碼不滿(mǎn)意，那么先給別人閱讀，然后讓閱讀者告訴你他為什么讀不懂，哪些地方讀著吃力。好的代碼應(yīng)該能夠讓你在幾個(gè)月后回顧自己的代碼時(shí)一目了然（架構(gòu)的清晰是代碼易讀的前提）。