主頁 > 知識庫 > rustysun同學(xué)ASP代碼書寫規(guī)范

rustysun同學(xué)ASP代碼書寫規(guī)范

熱門標(biāo)簽:外呼系統(tǒng)怎么話費 友邦互聯(lián)電銷機(jī)器人違法嗎 高質(zhì)量的電銷外呼系統(tǒng) 地圖標(biāo)注還可以做嗎 電銷機(jī)器人采購 宿州防封外呼系統(tǒng)平臺 滴滴地圖標(biāo)注上車點 硅基電話機(jī)器人加盟 無營業(yè)執(zhí)照地圖標(biāo)注教學(xué)
ASP源程序書寫規(guī)范
1       規(guī)范簡介
  本規(guī)范主要規(guī)定ASP源程序在書寫過程中所應(yīng)遵循的規(guī)則及注意事項。編寫該規(guī)范的目的是使項目開發(fā)人員的源代碼書寫習(xí)慣保持一致。這樣做可以使每一個組員都可以理解其它組員的代碼,以便于源代碼的二次開發(fā)記憶系統(tǒng)的維護(hù)。
2       一般格式規(guī)范
2.1       縮進(jìn)
縮進(jìn)就是在當(dāng)源程序的級改變時為增加可讀性而露出的兩個空格??s進(jìn)的規(guī)則為每一級縮進(jìn)四個空格。不準(zhǔn)許使用Tab。因為Tab會因為用戶所作的設(shè)置不同而產(chǎn)生不同的效果(如果習(xí)慣使用空格的話,可以在編輯器中設(shè)置將Tab換成四個空格)。當(dāng)進(jìn)入判斷(If…Then、Select…End Select)、循環(huán)(For[ Each]…Next、While…Loop)、With語句、函數(shù)、過程、類聲明的時侯增加一級, 當(dāng)遇到退出判斷、循環(huán)、with語句、函數(shù)、過程、類的時侯減少一級。例如:

CODE:
iTemp=0

If (iTemp> 100) Then
    iTemp = 100
End If

2.2       換行
換行就是在判斷、循環(huán)、With語句的起始與結(jié)束時各加入一個換行。函數(shù)、過程、類的聲明結(jié)束時,加入一個。換行是為了程序方便調(diào)試,可讀性更強(qiáng)。
例1:



CODE:
i=0

Do While (i10)
    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語法書寫格式規(guī)范
3.1       保留字
  VBScript語言的保留字或關(guān)鍵詞應(yīng)全部使用第一個字母大寫,其余字母小寫的原則(推薦)。另外也可采用全部小寫的方式,主要為了方便輸入源程序。
3.2       過程和函數(shù)
3.2.1       命名及格式
過程和函數(shù)的名稱應(yīng)全部使用有意義的英文單詞組成,并且第一個單詞全部小寫,其它單詞的第一個字母使用大寫字母。如果只有一個單詞,則第一個字母大寫。例如:



CODE:
Sub formatharddisk() '不正確的命名
Sub formatHardDisk ‘正確的命名
Sub show() ‘不正確的命名 
Sub Show() ‘正確的命名

設(shè)置變量內(nèi)容的過程和函數(shù),應(yīng)使用set作為前綴,例如:



CODE:
Sub setUserName

讀取變量內(nèi)容的過程和函數(shù),應(yīng)使用get作為前綴,例如:



CODE:
Function getUserName

3.2.2       過程和函數(shù)的參數(shù)
  首先所有參數(shù)名稱必須是有意義的。參數(shù)命名采用同義的英文,可使用幾個英文單詞,但每一個單詞的首字母必須大寫。先說明參數(shù)的引用類型,如ByVal或ByRef。參數(shù)名前加前綴‘a(chǎn)_',后跟參數(shù)的類型(參見變量類型中的書寫規(guī)范),必須小寫,最后跟參數(shù)名,單詞的第一個字母大寫。例如:



CODE:
Sub someProc(ByVal a_sUserName, ByVal a_iUserAge)

3.3       變量
3.3.1       變量命名及格式
首先所有變量必須起有意義的名字,使其它組員可以很容易讀懂變量所代表的意義,變量命名采用同義的英文命名,可使用幾個英文單詞,但每一單詞的首字母必須大寫。另外還需在變量名中體現(xiàn)變量類型。例如:



CODE:
Dim sWriteFormat ‘s表示String類型的變量

3.3.2       變量類型
  雖然在ASP中不須要聲明變量類型,它只有一個Variant型。但為了方便源程序的閱讀,我們決定為變量加上類型描述前綴。對于一些特定類型可采用一定的簡寫如下:
變量類型       簡寫
整型(Integer)       i
短整型(Short Integer)       sh
長整型(Long Integer)       l
單精度型(Single)       sn
雙精度型(Double)       db
字節(jié)型(Byte)       by
字符型(Char)       c
字符串型(String)       s
二進(jìn)制型(Binary)       bn
布爾型(Boolean)       b
日期時間型(DateTime)       d
數(shù)組型(Array)        a
象型(Object)       o
  循環(huán)控制變量通常使用單一的字符如:i, j, k。 另外使用一個有意義的名字,如iUserIndex ,也是準(zhǔn)許的。
3.3.3       全局變量(Global Variables)
  盡量不使用全局變量,如必須使用全局變量則必須加前綴‘gbl_',同時應(yīng)在變量名稱中體現(xiàn)變量的類型。
3.3.4       類級變量(Class Variables)
  類級變量主要是指在Class中,對整個Class內(nèi)部所有的屬性和方法都起作用的變量。在使用時必須加前綴'cls_',同時在變量名稱中體現(xiàn)變量的類型。
  例如:cls_iFileName
3.4       類(Class)
  類的名字必須有意義并且名字之前要加前綴‘T'。例如:



CODE:
Class TUpload

End Class

類實例的名字通常是去掉‘T'。例如:



CODE:
Dim oUpload : oUpload=new TUpload

3.5       表單(Form)
3.5.1       命名標(biāo)準(zhǔn)
表單及表單項命名應(yīng)該有意義,并且使用類型簡寫作為前綴。類型及簡寫如下表:
類型       簡寫
表單(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(本地數(shù)據(jù)庫所在路徑)
  -Doc(文檔所在路徑)
  -Help(幫助文件所在路徑)
  -Backup(備份路徑)
  -Temp(臨時文件路徑)
3.6.2       文件命名
   文件必須使用一個有意義的名字。例如:系統(tǒng)中一個錄入用戶資料表單的文件名為frmAddUser.asp,向數(shù)據(jù)庫中錄入用戶資料的文件名為addUser.asp。
3.6.3       文件頭
  在所有文件的頭部應(yīng)寫上此文件的用途,作者,最后修改日期、用途。例如:



CODE:
‘/**
‘*@ 作者:cjj
‘*@ 用途:上傳文件
‘*@ 創(chuàng)建日期:2006-11-29
‘*@ 修改歷史:
‘* cjj(修改人) 修改于 2006-11-30(修改日期) 為了解決…..(修改說明)。
‘* zs 修改于 2007-1-1 為了解決….
‘……..
‘*/

4       修改規(guī)范
  本規(guī)則所做的規(guī)定僅適用于已經(jīng)納入配置管理的程序。在這類修改中,要求保留修改前的內(nèi)容、并標(biāo)識出修改和新增的內(nèi)容。并在文件頭加入修改人、修改日期、修改說明等必要的信息。
4.1       修改歷史記錄
  對源文件進(jìn)行經(jīng)過批準(zhǔn)的修改時,修改者應(yīng)在程序文件頭加入修改歷史項。在以后的每一次修改時,修改者都必須在該項目中填寫下列信息:
4.2       新增代碼行
  新增代碼行的前后應(yīng)有注釋行說明。



CODE:
'(* cjj(修改人) 2006-10-11(修改時間) ….(修改說明)
……'(新增代碼行)
'cjj 2006-10-11 *)

4.3       刪除代碼行
刪除代碼行的前后用注釋行說明。



CODE:
‘(*修改人 修改時間 修改說明
‘要刪除的代碼行(將要刪除的語句進(jìn)行注釋)
‘修改人 修改時間 修改結(jié)束*)

4.4       修改代碼行
修改代碼行以刪除代碼行后在新增代碼行的方式進(jìn)行。



CODE:
‘(*修改人 修改時間 修改說明
‘修改前的代碼行 (注釋掉修改前的代碼行)
修改后的代碼行)
‘修改人 修改時間 修改結(jié)束*)
您可能感興趣的文章:
  • IntelliJ安裝并使用Rust IDE插件
  • 完美解決node.js中使用https請求報CERT_UNTRUSTED的問題
  • python實現(xiàn)封裝得到virustotal掃描結(jié)果
  • python實現(xiàn)上傳樣本到virustotal并查詢掃描信息的方法
  • you *might* want to use the less safe log_bin_trust_function_creators variable
  • Rust 能夠取代 C 語言嗎

標(biāo)簽:宣城 七臺河 新余 雅安 錫林郭勒盟 廣元 江門 儋州

巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《rustysun同學(xué)ASP代碼書寫規(guī)范》,本文關(guān)鍵詞  rustysun,同學(xué),ASP,代碼,書寫,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請?zhí)峁┫嚓P(guān)信息告之我們,我們將及時溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無關(guān)。
  • 相關(guān)文章
  • 下面列出與本文章《rustysun同學(xué)ASP代碼書寫規(guī)范》相關(guān)的同類信息!
  • 本頁收集關(guān)于rustysun同學(xué)ASP代碼書寫規(guī)范的相關(guān)信息資訊供網(wǎng)民參考!
  • 推薦文章