ASP源程序書寫規范
1 規范簡介
本規范主要規定ASP源程序在書寫過程中所應遵循的規則及注意事項。編寫該規范的目的是使項目開發人員的源代碼書寫習慣保持一致。這樣做可以使每一個組員都可以理解其它組員的代碼，以便於源代碼的二次開發記憶系統的維護。
2 一般格式規范
2.1 縮進
縮進就是在當源程序的級改變時為增加可讀性而露出的兩個空格。縮進的規則為每一級縮進四個空格。不准許使用Tab。因為Tab會因為用戶所作的設置不同而產生不同的效果(如果習慣使用空格的話，可以在編輯器中設置將Tab換成四個空格)。當進入判斷(If…Then、Select…End Select)、循環(For[ Each]…Next、While…Loop)、With語句、函數、過程、類聲明的時侯增加一級， 當遇到退出判斷、循環、with語句、函數、過程、類的時侯減少一級。例如：
CODE:
iTemp=0
If (iTemp<> 100) Then
iTemp = 100
End If
2.2 換行
換行就是在判斷、循環、With語句的起始與結束時各加入一個換行。函數、過程、類的聲明結束時，加入一個。換行是為了程序方便調試，可讀性更強。
例1：
CODE:
i=0
Do While (i<10)
i = i + 1
Loop
Response.Write(i & “<br/>”)
例2：
CODE:
Class class1
…..
End Class
Class class2
….
End Class
例3：
CODE:
Function fun1()
….
End Function
Sub sub1()
….
End Sub
2.3 空格
在操作符及邏輯判斷符號的兩端添加空格，例如：
CODE:
i = i + 1
a = a And b
sHTML = ”abc” & sHTML
但添加括號時不需要空格。例如：
CODE:
If ( a > b ) Then '錯誤的用法
If (a > b) Then ‘正確的用法
3 VBScript語法書寫格式規范
3.1 保留字
VBScript語言的保留字或關鍵詞應全部使用第一個字母大寫,其余字母小寫的原則(推薦)。另外也可采用全部小寫的方式，主要為了方便輸入源程序。
3.2 過程和函數
3.2.1 命名及格式
過程和函數的名稱應全部使用有意義的英文單詞組成，並且第一個單詞全部小寫，其它單詞的第一個字母使用大寫字母。如果只有一個單詞，則第一個字母大寫。例如：
CODE:
Sub formatharddisk() '不正確的命名
Sub formatHardDisk ‘正確的命名
Sub show() ‘不正確的命名
Sub Show() ‘正確的命名
設置變量內容的過程和函數，應使用set作為前綴，例如：
CODE:
Sub setUserName
讀取變量內容的過程和函數，應使用get作為前綴，例如：
CODE:
Function getUserName
3.2.2 過程和函數的參數
首先所有參數名稱必須是有意義的。參數命名采用同義的英文，可使用幾個英文單詞，但每一個單詞的首字母必須大寫。先說明參數的引用類型，如ByVal或ByRef。參數名前加前綴‘a_',後跟參數的類型(參見變量類型中的書寫規范)，必須小寫，最後跟參數名，單詞的第一個字母大寫。例如：
CODE:
Sub someProc(ByVal a_sUserName, ByVal a_iUserAge)
3.3 變量
3.3.1 變量命名及格式
首先所有變量必須起有意義的名字，使其它組員可以很容易讀懂變量所代表的意義，變量命名采用同義的英文命名，可使用幾個英文單詞，但每一單詞的首字母必須大寫。另外還需在變量名中體現變量類型。例如：
CODE:
Dim sWriteFormat ‘s表示String類型的變量
3.3.2 變量類型
雖然在ASP中不須要聲明變量類型，它只有一個Variant型。但為了方便源程序的閱讀，我們決定為變量加上類型描述前綴。對於一些特定類型可采用一定的簡寫如下：
變量類型 簡寫
整型(Integer) i
短整型(Short Integer) sh
長整型(Long Integer) l
單精度型(Single) sn
雙精度型(Double) db
字節型(Byte) by
字符型(Char) c
字符串型(String) s
二進制型(Binary) bn
布爾型(Boolean) b
日期時間型(DateTime) d
數組型(Array) a
象型(Object) o
循環控制變量通常使用單一的字符如：i, j, k。 另外使用一個有意義的名字，如iUserIndex ，也是准許的。
3.3.3 全局變量(Global Variables)
盡量不使用全局變量，如必須使用全局變量則必須加前綴‘gbl_'，同時應在變量名稱中體現變量的類型。
3.3.4 類級變量(Class Variables)
類級變量主要是指在Class中，對整個Class內部所有的屬性和方法都起作用的變量。在使用時必須加前綴'cls_'，同時在變量名稱中體現變量的類型。
例如：cls_iFileName
3.4 類(Class)
類的名字必須有意義並且名字之前要加前綴‘T'。例如：
CODE:
Class TUpload
…
End Class
類實例的名字通常是去掉‘T'。例如：
CODE:
Dim oUpload : oUpload=new TUpload
3.5 表單(Form)
3.5.1 命名標准
表單及表單項命名應該有意義，並且使用類型簡寫作為前綴。類型及簡寫如下表：
類型 簡寫
表單(Form) frm
文本框(TextBox,包括密碼框和多行文本框) txt
復選框(CheckBox) chk
單選框(Radio) rdo
按鈕(Button) btn
下拉框(Select) slt
3.6 文件
3.6.1 目錄結構
程序主目錄--Web（應用程序所在路徑）
-DB（本地數據庫所在路徑）
-Doc（文檔所在路徑）
-Help（幫助文件所在路徑）
-Backup（備份路徑）
-Temp（臨時文件路徑）
3.6.2 文件命名
文件必須使用一個有意義的名字。例如：系統中一個錄入用戶資料表單的文件名為frmAddUser.asp，向數據庫中錄入用戶資料的文件名為addUser.asp。
3.6.3 文件頭
在所有文件的頭部應寫上此文件的用途，作者，最後修改日期、用途。例如：
CODE:
‘/**
‘*@ 作者：cjj
‘*@ 用途：上傳文件
‘*@ 創建日期：2006-11-29
‘*@ 修改歷史：
‘* cjj(修改人) 修改於 2006-11-30(修改日期) 為了解決…..(修改說明)。
‘* zs 修改於 2007-1-1 為了解決….
‘……..
‘*/
4 修改規范
本規則所做的規定僅適用於已經納入配置管理的程序。在這類修改中，要求保留修改前的內容、並標識出修改和新增的內容。並在文件頭加入修改人、修改日期、修改說明等必要的信息。
4.1 修改歷史記錄
對源文件進行經過批准的修改時，修改者應在程序文件頭加入修改歷史項。在以後的每一次修改時，修改者都必須在該項目中填寫下列信息：
4.2 新增代碼行
新增代碼行的前後應有注釋行說明。
CODE:
'(* cjj(修改人) 2006-10-11(修改時間) ….(修改說明)
……'(新增代碼行)
'cjj 2006-10-11 *)
4.3 刪除代碼行
刪除代碼行的前後用注釋行說明。
CODE:
‘(*修改人 修改時間 修改說明
‘要刪除的代碼行（將要刪除的語句進行注釋）
‘修改人 修改時間 修改結束*)
4.4 修改代碼行
修改代碼行以刪除代碼行後在新增代碼行的方式進行。
CODE:
‘(*修改人 修改時間 修改說明
‘修改前的代碼行 (注釋掉修改前的代碼行)
修改後的代碼行）
‘修改人 修改時間 修改結束*)
