命名(規格)習慣 (VB)

[mini]

一開始就有好的命名習慣
是可增加程式的可讀性的
以下是 MSDN Library Visual Studio 6.0 (中文版) 解說

================================

變數的有效範圍字首
隨著專案愈趨龐大，劃分變數範圍的工作也變得更加迫切。您可在變數名稱前面再加上一個字母，來代表變數的有效範圍，如此既可輕易識別變數的範圍，變數名稱的長度也不會增加太多。

有效範圍 字首[/color] 範例
全域 g gstrUserName
模組層次 m mblnCalcInProgress
區域(程序層次) 無 dblVelocity


如果一個變數在一般模組或表單模組中，被宣告為 Public，那麼該變數就具有全域的有效範圍。如果一個變數在一般模組中被宣告為 Private，那麼該變數的有效範圍就是模組層次。

注意 一致性是有效使用這種技術的關鍵；Visual Basic 中的語法檢查工具並不會挑出以「p」開頭的模組層次變數。


常數
常數名稱是可以大小寫混合的。儘管標準 Visual Basic 常數並不包含資料型態和有效範圍資訊，但是像 i、s、g 和 m 這樣的字首對於理解一個常數的值和有效範圍還是很有用的。常數名稱應遵循與變數相同的規範，例如：

mintUserListMax 使用者清單項目的最大值 (整數，用於區域到模組)
gstrNewLine 換行字元 (字串，在應用程式中均可使用)

變數
宣告所有變數可節省程式撰寫的時間，因為輸入造成的錯誤可因此減少 (例如，將 aUserNameTmp，誤寫成 sUserNameTmp 或 sUserNameTemp)。您可在「選項」對話方塊的「編輯器」頁籤中，選定「要求變數宣告」選項，Option Explicit 陳述式會要求 Visual Basic 程式中所有的變數都須經過宣告。

應該給變數加字首來指明它們的資料型式。而且字首可以被延伸，用來指明變數的有效範圍，特別是對大型程式。

變數資料型態
您可使用下列字首來識別變數的資料型態：

資料型態 字首 範例
Boolean bln blnFound
EanB byt bytRasterData
NbyteCollection o col colWidgets
Ection o cur curRevenue
on objectCu dtm dtmStart
EctCur dbl dblTolerance
Curre err errOrderNum
RencyDa int intQuantity
Ydat lng lngDistance
Object obj objCurrent
EctSin sng sngAverage
Single str strFName
GleStringUser-def udt udtEmployee
User-de vnt vntCheckSum


描述變數和程序名稱
變數或程序的名稱應使用大小寫混合，並需足以描述其作用。函數名稱應該以動詞起首，如 InitNameArray 或 CloseDialog。

對於經常使用或太長的名稱，建議您使用標準縮寫，才不會使名稱太冗長。一般來說，超過 32 個字元的名稱，在 VGA 顯示器上就較不易於閱讀。

當使用縮寫時，要確保它們在整個應用程式中的一致性。在一個專案中，如果一會兒使用 Cnt， 一會兒使用 Count，將導致不必要的混淆。

使用者自訂型態
在一個有許多使用者自訂型態的大專案中，最好在為此型態命名時，使用一組特定的字首。若是以「u」開頭，那麼要識別使用者自訂型態就較為容易了。例如，ucli 可以用來做為一個使用者自訂的用戶端型態變數的字首。