ASP開發(fā)規(guī)范要求_

1、ASP開發(fā)規(guī)范要求_ 為了規(guī)范程序代碼編寫，提高代碼可讀性，降低后期維護(hù)成本，提高辦公效率，建議以后編寫的程序按以下幾條規(guī)范進(jìn)行： 一、 統(tǒng)一VBSCRIPT和ASP程序編寫規(guī)范： (一)變量命名規(guī)章： 由于在ASP和VBSCRIPT中由于不需要聲明變量，同時(shí)不能聲明變量的類型，但為了提高代碼的可讀性，養(yǎng)成好的開發(fā)習(xí)慣，對(duì)于本系統(tǒng)開發(fā)的變量命名統(tǒng)一規(guī)章如下： 1. 用法Dim、Public、Private聲明變量; 例如：Dim iStudentNum 2. 變量類型的體現(xiàn)： a、 整型變量：以小寫字母i開頭，后面跟變量標(biāo)示符，英文單詞的第一個(gè)字母大寫。 例如：下面聲明一個(gè)存儲(chǔ)數(shù)據(jù)庫記錄多少的

2、變量 Dim iResordsetNumber b、 單精度實(shí)體變量：以小寫字母f開頭，后面跟變量標(biāo)示符，英文單詞的第一個(gè)字母大寫。 c、 雙精度實(shí)體變量：以小寫字母d開頭，后面跟變量標(biāo)示符，英文單詞的第一個(gè)字母要大寫。 d、 字符型變量：以小寫字母s開頭; e、 布爾型變量：以小寫字母b開頭; f、 數(shù)組變量：數(shù)組類型+“_”+“Array”+“_”+“變量標(biāo)示符” 例如：定義一個(gè)存儲(chǔ)同學(xué)成績(jī)的數(shù)組(存儲(chǔ)單精度實(shí)體類型變量) Dim f_Array_StudentMark 3. 變量標(biāo)示符要符合標(biāo)示符標(biāo)準(zhǔn)，同時(shí)簡(jiǎn)單理解，盡量用法英文單詞來代替，盡量避開用法縮寫或簡(jiǎn)寫。 例如：存儲(chǔ)校友通訊錄的

3、字符串變量定義為： Dim sSchoolfellowAddressList; 雖然這樣定義在輸入的時(shí)候比較麻煩，但是，它大大提高了程序的可讀性，見其變量命名就知其意。在做變量查找的時(shí)候也比較便利。 速度和性能總是不能兩全，為了便利后者我們也就只有犧牲速度。 4.在變量定義后面加變量功能定義的說明。 (二)常量命名規(guī)章： 類型體現(xiàn)和上面一樣，不一樣的地方是，全部后面的標(biāo)示符全部大寫，例如： 定義一個(gè)存儲(chǔ)語言種類的的字符型常量： Const sLANGUAGE_TYPE=”Chinese” (三)功能函數(shù)、過程命名規(guī)章： 1. 用法Function聲明函數(shù)，用Sub聲明過程; 2. 函數(shù)名或過程

4、名的第一個(gè)字母大寫，且后面的每個(gè)單詞第一個(gè)字母大寫。 例如： Function CheckValidityOfInput(sStuentMark) 此處寫代碼 End Function 3. 函數(shù)名或過程名要簡(jiǎn)單讀，簡(jiǎn)潔明白。 4. 在函數(shù)前面加說明，說明函數(shù)功能、參數(shù)說明、創(chuàng)建日期、修改日期、修改緣由、創(chuàng)建人、修改人等相關(guān)信息。 (四)代碼縮進(jìn)標(biāo)準(zhǔn)： 為了提高代碼的美觀型和易讀性，在此提出代碼編寫的版面格式：區(qū)間與區(qū)間之間以一個(gè)為間距。 例如： * 功能：檢測(cè)輸入字符串中的單引號(hào)，假如有則把原來的一個(gè)單引號(hào)變成兩 個(gè)單引號(hào)，兩個(gè)變成四個(gè)，依次類推，從而避開SQL語句執(zhí)行錯(cuò)誤。 創(chuàng)建人：XXX

5、X 創(chuàng)建時(shí)間：2021-7-6 修改時(shí)間： 修改緣由： 修改人： 輸入?yún)?shù)說明：sInputString：需要進(jìn)行單引號(hào)檢測(cè)的字符串 * Function CheckValidityOfInput(sInputString) Dim iCirculationControl 掌握循環(huán) Dim sApartString 分別字符檢測(cè) Dim iLenOfInput 輸入字符長(zhǎng)度 iLen= Len(Trim(sInputString) For iCirculationControl = 1 To iLen If Mid(sInputString, iCirculationControl, 1) T

6、hen sApartString = sApartString _ Mid(Trim(sInputString), iCirculationControl , 1) Else sApartString = sApartString End If Next CheckValidityOfInput = sApartString End Function 二、 統(tǒng)一JavaScript程序編寫規(guī)范： JavaScript的命名規(guī)章和上面大部分相同，唯一不同的地方是：變量用法Var來聲明，在聲明結(jié)束后以分號(hào)(;)結(jié)束。 函數(shù)的代碼要求層次清晰，該寫在下一行的地方盡量往下一行寫，不要在一行中完成全部代

7、碼，這樣看起來不簡(jiǎn)單，檢查錯(cuò)誤也格外費(fèi)時(shí)。 在寫函數(shù)的時(shí)候記著加說明內(nèi)容，以便以后維護(hù)時(shí)快速了解程序功能。 下面是一個(gè)JavaScript程序： 三、 系統(tǒng)性能提高，代碼規(guī)范： 1.在ASP頁面內(nèi)，凡是用法CreageObject()創(chuàng)建的對(duì)象(Com、Recordset等)，對(duì)于這些變量，應(yīng)當(dāng)在該頁結(jié)束進(jìn)行對(duì)象釋放：即 Set 對(duì)象變量名=Nothing 2.數(shù)據(jù)庫打開以后在不用的時(shí)候(通常是本頁最終面)，需要對(duì)連接進(jìn)行關(guān)閉; 3.對(duì)于SQL語句，存儲(chǔ)過程，盡量避開用法*來取全部字段,為了代碼的易讀性，SQL關(guān)鍵字要求全部大寫，字段部分小寫。 例如： SELECT name,age,birt

8、hday,telephone,address FROM SchoolFellow.Address WHERE name=xxxx ORDER BY birthday DESC 4.在ASP頁中全部屬性值盡量用法雙引號(hào)括起來，格外是有屬性Value的值，不要由于省時(shí)間而把雙引號(hào)去掉(有的地方雖然可以去掉，程序不會(huì)消失錯(cuò)誤，但，在有的地方去掉雙引號(hào)會(huì)引來更多的麻煩。) 例如： ” 在這個(gè)例子中，假如把Value屬性值的單引號(hào)去掉，假如數(shù)據(jù)庫中出來的值有空格，空格后面還有值，結(jié)果，顯示的內(nèi)容只有空格前面的內(nèi)容，而后面的內(nèi)容就會(huì)丟失。這只是其中一種狀況，其他還有許多未知狀況發(fā)生。 5. 配對(duì)標(biāo)簽問題：

9、對(duì)于象之類的標(biāo)簽，要留意檢查配對(duì)的位值，有沒有結(jié)束標(biāo)記。 6. 對(duì)于需要輸入字符串，且需要用法SQL語句的地方，需要進(jìn)行單引號(hào)處理，調(diào)用/include/CheckQ.asp中的兩個(gè)方法(一個(gè)是客戶端處理，一個(gè)是服務(wù)器端處理，依據(jù)需要進(jìn)行調(diào)用，平安性要求高的地方多數(shù)狀況下采納服務(wù)器端處理。)之一。 7. 為了提高平安性，能用法ASP編寫的代碼，盡量采納ASP編寫，在服務(wù)器端運(yùn)行，不讓用戶看到代碼。 8. 對(duì)于平安性要求格外高的地方，建議采納三層結(jié)構(gòu)：用法VB或Delphi編寫商業(yè)規(guī)律層代碼(COM)，盡量把數(shù)據(jù)庫的連接部分封裝到組件中，提高平安性能，通過組件和數(shù)據(jù)庫溝通。 9. 對(duì)于網(wǎng)站的平安性，應(yīng)當(dāng)采納好的斷口掃描軟件，查看網(wǎng)站已經(jīng)打開的斷口，把擔(dān)心全的斷口給關(guān)閉。 四、 養(yǎng)成寫開發(fā)文檔的習(xí)慣： 對(duì)于每一個(gè)頁面設(shè)計(jì)(前接頁，后接頁)，包括功能說明，頁面設(shè)計(jì)，頁面名稱，存放位