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