軟件開發(fā)過(guò)程文檔ASP編碼規(guī)范.doc

計(jì)算機(jī)源代碼編寫規(guī)范(ASP編碼規(guī)范)編 號(hào)：MPDK/ZY-02-2007修 改 號(hào)：0發(fā) 放 號(hào)：發(fā)布時(shí)間：2007-06-28實(shí)施時(shí)間：2007-06-28編 制：批 準(zhǔn)：ASP編碼規(guī)約1目的12.適用范圍13規(guī)范內(nèi)容11目的規(guī)范ASP代碼編寫人員的編程工作。2.適用范圍適合本公司所有ASP代碼編寫人員使用。3規(guī)范內(nèi)容31數(shù)據(jù)庫(kù)開發(fā)數(shù)據(jù)文件命名采用系統(tǒng)名+文件類型，比如系統(tǒng)名為kupage,則數(shù)據(jù)庫(kù)文件命名為kupage_database.mdf，有的數(shù)據(jù)庫(kù)文件有多個(gè)，比如SQL Server就有2個(gè)，一個(gè)是數(shù)據(jù)庫(kù)文件，另一個(gè)是日志文件，那么他們的文件命名分別為kupage_database.mdf，kupage_log.log。文件名全部采用小寫。 數(shù)據(jù)庫(kù)表命名規(guī)范，表名長(zhǎng)度不能超過(guò)30個(gè)字符，表名中含有單詞全部采用單數(shù)形式，單詞首寫字母要大寫，多個(gè)單詞間不用任何連接符號(hào)。若庫(kù)中有多個(gè)系統(tǒng)，表名采用系統(tǒng)名稱+單詞或多個(gè)單詞，系統(tǒng)名是開發(fā)系統(tǒng)的縮寫，系統(tǒng)名稱全部采用小寫英文字符,如bbsTitle,bbsForumType。若庫(kù)中只含有一個(gè)系統(tǒng)，那么表名僅用一個(gè)單詞或多個(gè)單詞。單詞選擇能夠概括表內(nèi)容的一個(gè)或多個(gè)英文單詞，如UserInfo,UserType。關(guān)連表命名規(guī)則為Re_表A_表B,Re是Relative的縮寫，如：Re_User_ArticleType, Re_User_FormType。數(shù)據(jù)庫(kù)字段命名規(guī)范，數(shù)據(jù)庫(kù)字段名全部采用小寫英文單詞，單詞之間用”_”隔開，命名規(guī)則是表別名+單詞，如：user_name,user_pwd。表別名規(guī)則，如果表名是一個(gè)單詞，別名就取單詞的前4 個(gè)字母；如果表名是兩個(gè)單詞，就各取兩個(gè)單詞的前兩個(gè)字母組成4 個(gè)字母長(zhǎng)的別名；如果表的名字由3 個(gè)單詞組成，你不妨從頭兩個(gè)單詞中各取一個(gè)然后從最后一個(gè)單詞中再取出兩個(gè)字母，結(jié)果還是組成4 字母長(zhǎng)的別名。視圖名采用規(guī)則：View_表A_表B_表C,View表示視圖。這個(gè)視圖由幾個(gè)表產(chǎn)生就用”_”連接幾個(gè)表的名，如果表過(guò)多可以將表名適當(dāng)簡(jiǎn)化，但一定要列出所有表名。存儲(chǔ)過(guò)程命名規(guī)則P_表名_存取過(guò)程名(縮寫)，比如P_User_Del，P_ArticleType_AddData。SQL語(yǔ)句編寫規(guī)則，關(guān)鍵字必須大寫，其他書寫按上述命名規(guī)則，比如：SELECT user_id, user_name FROM User WHERE user_id = tom3.2.文件夾文件名命名規(guī)范文件夾命名一般采用英文，長(zhǎng)度一般不超過(guò)20個(gè)字符，命名采用小寫字母。除特殊情況才使用中文拼音，一些常見的文件夾命名如：images(存放圖形文件)，flash（存放Flash文件），style(存放CSS文件)，scripts（存放Javascript腳本），inc(存放include文件)，link（存放友情鏈接）,media(存放多媒體文件)等。文件名稱統(tǒng)一用小寫的英文字母、數(shù)字和下劃線的組合。命名原則的指導(dǎo)思想一是使得你自己和工作組的每一個(gè)成員能夠方便的理解每一個(gè)文件的意義，二是當(dāng)我們?cè)谖募A中使用“按名稱排例”的命令時(shí)，同一種大類的文件能夠排列在一起，以便我們查找、修改、替換、計(jì)算負(fù)載量等等操作 。1)、圖片的命名原則名稱分為頭尾兩部分，用下劃線隔開，頭部分表示此圖片的大類性質(zhì)例如廣告、標(biāo)志、菜單、按鈕等等。 放置在頁(yè)面頂部的廣告、裝飾圖案等長(zhǎng)方形的圖片取名： banner 標(biāo)志性的圖片取名為： logo在頁(yè)面上位置不固定并且?guī)в墟溄拥男D片我們?nèi)∶麨?button 在頁(yè)面上某一個(gè)位置連續(xù)出現(xiàn)，性質(zhì)相同的鏈接欄目的圖片我們?nèi)∶?menu 裝飾用的照片我們?nèi)∶?pic 不帶鏈接表示標(biāo)題的圖片我們?nèi)∶?title 下面是幾個(gè)范例： banner_sohu.gif 、banner_sina.gif、 menu_aboutus.gif 、menu_job.gif、 title_news.gif、 logo_police.gif、 logo_national.gif 、pic_people.jpg 。2)、動(dòng)態(tài)語(yǔ)言文件命名規(guī)則性質(zhì)_描述，描述可以有多個(gè)單詞，用”_”隔開，性質(zhì)一般是該頁(yè)面的概要。范例：register_form.asp，register_post.asp,topic_lock.asp3.程序代碼編程規(guī)范一個(gè)良好的程序編碼風(fēng)格有利于系統(tǒng)的維護(hù)，代碼也易于閱讀查錯(cuò)。在此只討論ASP的編程風(fēng)格和約定。在ASP中所有變量是弱變量，無(wú)需定義就可以直接使用，而且代碼不區(qū)分大小寫。但其他語(yǔ)言一般這些都要定義的，為了養(yǎng)成良好的編程習(xí)慣，編寫代碼務(wù)必按照一下規(guī)則。 1)、每個(gè)變量名必須定義，在ASP文件的最開始添加語(yǔ)句，強(qiáng)制定制每個(gè)變量。2)、程序代碼需要有縮進(jìn)，縮進(jìn)采用鍵盤Tab鍵，不采用空格鍵。并且”或者鏈接字符串時(shí)需要左右空一格。3)、函數(shù)過(guò)程編寫的約定。函數(shù)或者過(guò)程命名采用動(dòng)作+名詞，每個(gè)函數(shù)需要給出相應(yīng)的注釋，函數(shù)功能，傳入變量，以及作者和修改相關(guān)信息。如下面函數(shù):%功能 返回一個(gè)參數(shù)的值 參數(shù) strParameterName 參數(shù)名稱作者 icefire 2002/8/20 amFunction GetParameterValue(strParameterName)Dim objRS, strSQL, strParameterValuestrSQL = SELECT ParameterValue FROM damsParameters WHERE ParameterName = & strParameterName & .GetParameterValue = strParameterValueSet objRS = NothingEnd Function4）、ASP內(nèi)置對(duì)象區(qū)分大小寫。如下代碼片斷strUserName = Request.Form(“UserName”)Set conn = Server.CreateObject(ADODB.Connection)5)、數(shù)據(jù)庫(kù)連接一個(gè)庫(kù)只能有一個(gè)數(shù)據(jù)庫(kù)連接文件，創(chuàng)建數(shù)據(jù)庫(kù)對(duì)象的原則是盡可能晚地打開數(shù)據(jù)庫(kù)，盡可能早地關(guān)閉數(shù)據(jù)庫(kù)。創(chuàng)建數(shù)據(jù)庫(kù)對(duì)象調(diào)用統(tǒng)一地創(chuàng)建函數(shù)。如下：Sub OpenConn(ByRef conn)Dim strDBPath, strDBConnectionstrDBPath = Server.MapPath(database/tax.mdb)strDBConnnection = Driver=Microsoft Access Driver (*.mdb); DBQ= & strDBPathSet conn = Server.CreateObject(ADODB.Connection)conn.Open strDBConnnectionEnd Sub6)、當(dāng)一個(gè)對(duì)象不再使用時(shí)要釋放對(duì)象資源，比如objFSO,objRS對(duì)象等。采用統(tǒng)一函數(shù)調(diào)用。函數(shù)如下：Sub Close