rustysun同學ASP代碼書寫規範

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:
‘(*修改人 修改時間 修改說明
‘修改前的程式碼 (注釋掉修改前的程式碼)
修改後的程式碼）
‘修改人 修改時間 修改結束*)