AS!P開發規范要求

發布時間:2017-08-17 20:10 來源:互聯網 當前欄目:web技術類

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

  一、 統一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.在變量定義后面加變量功能定義的注釋。

  (二)常量命名規則:

  類型體現和上面一樣,不一樣的地方是,所有后面的標示符全部大

中國歷史事件[www.9-39.com/html/china/]
寫,例如:

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

  Const sLANGUAGE_TYPE=”Chinese”

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

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

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

  例如:

  Function CheckValidityOfInput(sStuentMark)

  ‘此處寫代碼

  …………

  End Function

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

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

  (四)代碼縮進標準:

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

  例如:

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

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

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

  ‘創建人:XXXX

  ‘創建時間:2002-7-6

  ‘修改時間:

  ‘修改原因:

  ‘修改人:

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

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

  • 1、
  • 2、
  • 3、
  • 4、
  • 5、
  • 6、
  • 7、
  • 8、
  • 9、
  • 10、
  • 11、
  • 12、
  • 13、
  • 14、
  • 15、
  • 16、
  • 17、
  • 18、
  • 19、
  • 20、
  • 21、
  • 22、
  • 23、
  • 24、
  • 25、
  • 1、
  • 2、
  • 3、
  • 4、
  • 5、
  • 6、
  • 7、
  • 8、
  • 9、
  • 10、
  • 11、
  • 12、
  • 13、
  • 14、
  • 15、
  • 16、
  • 17、
  • 18、
  • 19、
  • 20、
  • 21、
  • 22、
  • 23、
  • 24、
  • 25、