代碼書寫規(guī)范說明

《代碼書寫規(guī)范說明》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在應(yīng)用文檔-天天文庫。

1、代碼編寫規(guī)范說明書（c#.net與asp.net）目錄1目的2范圍3注釋規(guī)范3.1概述3.2自建代碼文件注釋3.3模塊（類）注釋3.4類屬性注釋3.5方法注釋3.6代碼間注釋4命名總體規(guī)則5命名規(guī)范5.1變量（Variable）命名5.2常量命名5.3類（Class）命名5.4接口（Interface）命名5.5方法（Method）命名5.6名稱空間Namespace）命名6編碼規(guī)則6.1錯誤檢查規(guī)則6.2大括號規(guī)則6.3縮進(jìn)規(guī)則6.4小括號規(guī)則6.5IfThenElse規(guī)則6.6比較規(guī)則6.7Case規(guī)則6.8對齊規(guī)則6.9單語句規(guī)則6.10

2、單一功能規(guī)則6.11簡單功能規(guī)則6.12明確條件規(guī)則6.13選用FALSE規(guī)則6.14獨立賦值規(guī)則6.15定義常量規(guī)則6.16模塊化規(guī)則6.17交流規(guī)則7編程準(zhǔn)則7.1變量使用7.2數(shù)據(jù)庫操作7.3對象使用7.4模塊設(shè)計原則7.5結(jié)構(gòu)化要求7.6函數(shù)返回值原則8代碼包規(guī)范8.1代碼包的版本號8.2代碼包的標(biāo)識9代碼的控制9.1代碼庫/目錄的建立9.2代碼歸檔10輸入控制校驗規(guī)則10.1登陸控制10.2數(shù)據(jù)錄入控制附件1：數(shù)據(jù)類型縮寫表附件2：服務(wù)器控件名縮寫表1目的一.為了統(tǒng)一公司軟件開發(fā)設(shè)計過程的編程規(guī)范二.使網(wǎng)站開發(fā)人員能很方便的理解每個目

3、錄,變量，控件，類，方法的意義三.為了保證編寫出的程序都符合相同的規(guī)范，保證一致性、統(tǒng)一性而建立的程序編碼規(guī)范。四.編碼規(guī)范和約定必須能明顯改善代碼可讀性，并有助于代碼管理、分類范圍適用于企業(yè)所有基于.NET平臺的軟件開發(fā)工作2范圍本規(guī)范適用于開發(fā)組全體人員，作用于軟件項目開發(fā)的代碼編寫階段和后期維護(hù)階段。3注釋規(guī)范3.1概述a)注釋要求英文及英文的標(biāo)點符號。b)注釋中，應(yīng)標(biāo)明對象的完整的名稱及其用途，但應(yīng)避免對代碼過于詳細(xì)的描述。c)每行注釋的最大長度為100個字符。d)將注釋與注釋分隔符用一個空格分開。e)不允許給注釋加外框。f)編碼的同時

4、書寫注釋。g)重要變量必須有注釋。h)變量注釋和變量在同一行，所有注釋必須對齊，與變量分開至少四個“空格”鍵。如：intm_iLevel,m_iCount;//m_iLevel....treelevel//m_iCount....countoftreeitemsstringm_strSql;//SQLi)典型算法必須有注釋。j)在循環(huán)和邏輯分支地方的上行必須就近書寫注釋。k)程序段或語句的注釋在程序段或語句的上一行l(wèi))在代碼交付之前，必須刪掉臨時的或無關(guān)的注釋。m)為便于閱讀代碼，每行代碼的長度應(yīng)少于100個字符。3.2自建代碼文件注釋對于自己

5、創(chuàng)建的代碼文件（如函數(shù)、腳本），在文件開頭，一般編寫如下注釋：/******************************************************FileName:Copyright(c)2004-xxxx*********公司技術(shù)開發(fā)部Writer:createDate:Rewriter:RewriteDate:Impact:MainContent（FunctionName、parameters、returns）*****************************************************

6、*/3.3模塊（類）注釋模塊開始必須以以下形式書寫模塊注釋：///

7、容注釋掉，然后添加新代碼使用以下注釋：///AddedbyAdddate：<添加日期，格式：YYYY-MM-DD>Start2：///End2：如果模塊輸入輸出參數(shù)或功能結(jié)構(gòu)有較大修改，則每次修改必須添加以下注釋：///