程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> 網頁編程 >> ASP編程 >> 關於ASP編程 >> ASP開發規范要求

ASP開發規范要求

編輯:關於ASP編程

       為了規范程序代碼編寫,提高代碼可讀性,降低後期維護成本,提高辦公效率,建議以後編寫的程序按以下幾條規范進行:

      一、 統一VBSCRIPT和ASP程序編寫規范:

      (一)變量命名規則:

      由於在ASP和VBSCRIPT中因為不需要聲明變量,同時不能聲明變量的類型,但為了提高代碼的可讀性,養成好的開發習慣,對於本系統開發的變量命名統一規則如下:

      1. 使用Dim、Public、Private聲明變量;

      例如:Dim iStudentNum

      2. 變量類型的體現:

      a、 整型變量:以小寫字母i開頭,後面跟變量標示符,英文單詞的第一個字母大寫。

      例如:下面聲明一個存儲數據庫記錄多少的變量

      Dim iResordsetNumber

      b、 單精度實體變量:以小寫字母f開頭,後面跟變量標示符,英文單詞的第一個字母大寫。

      c、 雙精度實體變量:以小寫字母d開頭,後面跟變量標示符,英文單詞的第一個字母要大寫。

      d、 字符型變量:以小寫字母s開頭;

      e、 布爾型變量:以小寫字母b開頭;

      f、 數組變量:數組類型+“_”+“Array”+“_”+“變量標示符”

      例如:定義一個存儲學生成績的數組(存儲單精度實體類型變量)

      Dim f_Array_StudentMark

      3. 變量標示符要符合標示符標准,同時容易理解,盡量使用英文單詞來代替,盡量避免使用縮寫或簡寫。

      例如:存儲校友通訊錄的字符串變量定義為:

      Dim sSchoolfellowAddressList;

      雖然這樣定義在輸入的時候比較麻煩,但是,它大大提高了程序的可讀性,見其變量命名就知其意。在做變量查找的時候也比較方便。 速度和性能總是不能兩全,為了方便後者我們也就只有犧牲速度。

      4.在變量定義後面加變量功能定義的注釋。

      (二)常量命名規則:

      類型體現和上面一樣,不一樣的地方是,所有後面的標示符全部大寫,例如:

      定義一個存儲語言種類的的字符型常量:

      Const sLANGUAGE_TYPE=”Chinese”

      (三)功能函數、過程命名規則:

      1. 使用Function聲明函數,用Sub聲明過程;

      2. 函數名或過程名的第一個字母大寫,且後面的每個單詞第一個字母大寫。

      例如:

      Function CheckValidityOfInput(sStuentMark)

      ‘此處寫代碼

      …………

      End Function

      3. 函數名或過程名要容易讀,簡單明了。

      4. 在函數前面加注釋,說明函數功能、參數說明、創建日期、修改日期、修改原因、創建人、修改人等相關信息。

      (四)代碼縮進標准:

      為了提高代碼的美觀型和易讀性,在此提出代碼編寫的版面格式:區間與區間之間以一個為間距。

      例如:

      ‘***********************************************************

      ‘功能:檢測輸入字符串中的單引號,如果有則把原來的一個單引號變成兩

      ‘ 個單引號,兩個變成四個,依次類推,從而避免SQL語句執行錯誤。

      ‘創建人:XXXX

      ‘創建時間:2002-7-6

      ‘修改時間:

      ‘修改原因:

      ‘修改人:

      ‘輸入參數說明:sInputString:需要進行單引號檢測的字符串

      ‘***********************************************************

      Function CheckValidityOfInput(sInputString)

      Dim iCirculationControl ‘控制循環

      Dim sApartString ‘分離字符檢測

      Dim iLenOfInput ‘輸入字符長度

      iLen= Len(Trim(sInputString))

      For iCirculationControl = 1 To iLen

      If Mid(sInputString, iCirculationControl, 1) <>"'" Then

      sApartString = sApartString & _

      Mid(Trim(sInputString), iCirculationControl , 1)

      Else

      sApartString = sApartString & "''"

      End If

      Next

      CheckValidityOfInput = sApartString

      End Function

      二、 統一JavaScript程序編寫規范:

      JavaScript的命名規則和上面大部分相同,唯一不同的地方是:變量使用Var來聲明,在聲明結束後以分號(;)結束。

      函數的代碼要求層次清楚,該寫在下一行的地方盡量往下一行寫,不要在一行中完成所有代碼,這樣看起來不容易,檢查錯誤也特別費時。

      在寫函數的時候記著加注釋內容,以便以後維護時快速了解程序功能。

      下面是一個JavaScript程序:

      三、 系統性能提高,代碼規范:

      1.在ASP頁面內,凡是使用CreageObject()創建的對象(Com、Recordset等),對於這些變量,應當在該頁結束進行對象釋放:即

      Set 對象變量名=Nothing

      2.數據庫打開以後在不用的時候(通常是本頁最後面),需要對連接進行關閉;

      3.對於SQL語句,存儲過程,盡量避免使用*來取所有字段,為了代碼的易讀性,SQL關鍵字要求全部大寫,字段部分小寫。

      例如:

      SELECT name,age,birthday,telephone,address FROM SchoolFellow.Address WHERE name=’xxxx’ ORDER BY birthday DESC

      4.在ASP頁中所有屬性值盡量使用雙引號括起來,特別是有屬性Value的值,不要因為省時間而把雙引號去掉(有的地方雖然可以去掉,程序不會出現錯誤,但,在有的地方去掉雙引號會引來更多的麻煩。)

      例如:

      ”>

      在這個例子中,如果把Value屬性值的單引號去掉,如果數據庫中出來的值有空格,空格後面還有值,結果,顯示的內容只有空格前面的內容,而後面的內容就會丟失。這只是其中一種情況,其他還有很多未知情況發生。

      5. 配對標簽問題:對於象之類的標簽,要注意檢查配對的位值,有沒有結束標志。

      6. 對於需要輸入字符串,且需要使用SQL語句的地方,需要進行單引號處理,調用/include/CheckQ.asp中的兩個方法(一個是客戶端處理,一個是服務器端處理,根據需要進行調用,安全性要求高的地方多數情況下采用服務器端處理。)之一。

      7. 為了提高安全性,能使用ASP編寫的代碼,盡量采用ASP編寫,在服務器端運行,不讓用戶看到代碼。

      8. 對於安全性要求特別高的地方,建議采用三層結構:使用VB或Delphi編寫商業邏輯層代碼(COM),盡量把數據庫的連接部分封裝到組件中,提高安全性能,通過組件和數據庫交流。

      9. 對於網站的安全性,應該采用好的斷口掃描軟件,查看網站已經打開的斷口,把不安全的斷口給關閉。

      四、 養成寫開發文檔的習慣:

      對於每一個頁面設計(前接頁,後接頁),包括功能說明,頁面設計,頁面名稱,存放位置等,應當有相應的文檔記載。對於發生改動的地方,需要保留原來的部分(注釋或備份),並說明備份文件存放的地方,改動時間,修改人。

      對於程序部分,應該有相應的設計流程,改動的時候,也需要設計改動流程圖,以便以後進行對比,和查找問題所在位置,以及問題的嚴重性分析。

    1. 上一頁:
    2. 下一頁:
    Copyright © 程式師世界 All Rights Reserved