C#代碼開發(fā)命名規(guī)范示例

1、代碼開發(fā)命名規(guī)范擬稿該規(guī)范的制定致力于規(guī)范代碼格式，提高開發(fā)效率，保證程序質(zhì)量，最終解釋權(quán)歸*軟件開發(fā)組。1. 項(xiàng)目名稱及類庫(kù)命名規(guī)范項(xiàng)目名稱：Testlatform,簡(jiǎn)寫Test實(shí)體類類庫(kù)命名：Test.Model業(yè)務(wù)邏輯類類庫(kù)命名：Test.BLL數(shù)據(jù)工廠類類庫(kù)命名：Test.DALFactory數(shù)據(jù)庫(kù)幫助類類庫(kù)命名：Test.DBUtility數(shù)據(jù)接口類類庫(kù)命名：Test.IDAL數(shù)據(jù)訪問(wèn)層類類庫(kù)命名：Test.SQLServerDAL常用幫助類類庫(kù)命名：Test.Utils表現(xiàn)層類庫(kù)命名：Test.UI2. 數(shù)據(jù)庫(kù)名稱及字段命名規(guī)范1） 數(shù)據(jù)庫(kù)命名數(shù)據(jù)庫(kù)命名：同項(xiàng)目名稱簡(jiǎn)寫（Test）

2、2） 實(shí)體（表）命名規(guī)則：前綴_表存儲(chǔ)內(nèi)容簡(jiǎn)稱舉例：Sys_User 【系統(tǒng)用戶表】Sys_Role【角色表】3） 屬性（列）命名規(guī)則：前綴+列存儲(chǔ)內(nèi)容簡(jiǎn)稱舉例：UserID【用戶編號(hào)】UserIDRoleName【角色名稱】4） 視圖命名：規(guī)則：視圖以V作為前綴，其他命名規(guī)則和表的命名類似；命名應(yīng)盡量體現(xiàn)各視圖的功能。舉例：V_GetUserLogInfo【獲取用戶的登錄信息】5） 觸發(fā)器的命名規(guī)則：觸發(fā)器以TR作為前綴，觸發(fā)器名為相應(yīng)的表名加上后綴，Insert觸發(fā)器加_I，Delete觸發(fā)器加_D，Update觸發(fā)器加_U， 舉例：TR_User_I【添加用戶時(shí)激發(fā)】6） 存儲(chǔ)過(guò)程命名規(guī)

3、則：存儲(chǔ)過(guò)程應(yīng)以UP_開頭，和系統(tǒng)的存儲(chǔ)過(guò)程區(qū)分，后續(xù)部分以存儲(chǔ)過(guò)程內(nèi)容加存儲(chǔ)過(guò)程的動(dòng)作構(gòu)成（參考動(dòng)軟代碼生成器生成存儲(chǔ)過(guò)程的規(guī)則），并用下劃線分割各個(gè)組成部分。舉例：UP_Sys_User_Update【更新系統(tǒng)用戶信息】7） 變量命名規(guī)則：變量名采用小寫，若屬于詞組形式，用下劃線分隔每個(gè)單詞，舉例：my_err_no。8） 命名中其他注意事項(xiàng)a. 以上命名都不得超過(guò)30個(gè)字符的系統(tǒng)限制。變量名的長(zhǎng)度限制為29（不包括標(biāo)識(shí)字符）。b. 數(shù)據(jù)對(duì)象、變量的命名都采用英文字符，禁止使用中文命名。絕對(duì)不要在對(duì)象名的字符之間留空格。c. 小心保留詞，要保證你的字段名沒(méi)有和保留詞、數(shù)據(jù)庫(kù)系統(tǒng)或者常用訪問(wèn)

4、方法沖突d. 保持字段名和類型的一致性，在命名字段并為其指定數(shù)據(jù)類型的時(shí)候一定要保證一致性。假如數(shù)據(jù)類型在一個(gè)表里是整數(shù)，那在另一個(gè)表里可就別變成字符型了。3. 項(xiàng)目代碼命名規(guī)范1) ADO.NET 命名規(guī)范注釋：動(dòng)軟代碼生成器生成的邏輯代碼除外。數(shù)據(jù)類型數(shù)據(jù)類型簡(jiǎn)寫標(biāo)準(zhǔn)命名舉例ConnectionconconNorthwindCommandcmdcmdReturnProductsParameterparmparmProductIDDataAdapterdaddadProductsDataReaderdtrdtrProductsDataSetdstdstNorthWindDataTabledt

5、bldtblProductDataRowdrowdrowRow98DataColumndcoldcolProductIDDataRelationdreldrelMasterDetailDataViewdvwdvwFilteredProducts2) WebControl 命名規(guī)范Web控件名簡(jiǎn)寫標(biāo)準(zhǔn)命名舉例AdRotatoradrtadrtExampleButtonbtnbtnSubmitCalendarcalcalMettingDatesCheckBoxchkchkBlueCheckBoxListchklchklFavColorsCompareValidatorvalcvalcValidAg

6、eCustomValidatorvalxvalxDBCheckDataGriddgrddgrdTitlesDataListdlstdlstTitlesDropDownListdropdropCountriesHyperLinklnklnkDetailsImageimgimgAuntBettyImageButtonibtnibtnSubmitLabellbllblResultsLinkButtonlbtnlbtnSubmitListBoxlstlstCountriesPanelpnlpnlForm2PlaceHolderplhplhFormContentsRadioButtonradradFem

7、aleRadioButtonListradlradlGenderRangeValidatorvalgvalgAgeRegularExpressionvalevaleEmail_ValidatorRepeaterrptrptQueryResultsRequiredFieldValidatorvalrvalrFirstNameTabletbltblCountryCodesTableCelltblctblcGermanyTableRowtblrtblrCountryTextBoxtxttxtFirstNameValidationSummaryvalsvalsFormErrorsXMLxmlcxmlc

8、TransformResults3) HTML控件命名規(guī)則HTML控件名簡(jiǎn)寫標(biāo)準(zhǔn)命名舉例HtmlAnchorhahhahUserDetialHtmlButtonhbtnhbtnConfirm HtmlFormhformhformFromUserHtmlGenericControlhgcHtmlImagehimghimgHeaderHtmlInputButton（按鈕）hbbtnhbbtnButtonHtmlInputButton（重置）hrbtnhrbtnResetHtmlInputButton（提交）hcbtnhcbtnSubmit HtmlInputCheckBoxhickhickSele

9、ctAllHtmlInputFilehifilehifileUploadFileHtmlInputHiddenhihidhihidUserIDHtmlInputImagehiimghiimgUserUpdateHtmlInputRadioButtonhirbhirbSelectUserHtmlInputText（密碼）hipwdhipwdUserPassHtmlInputText（文本）hitxthitxtUserNameHtmlSelecthslthsltUserHtmlTablehtabhtabHeaderHtmlTableCellhtchtcUserNameHtmlTableRowhtr

10、htrTitleHtmlTextAreahtxtahtxtaNotes4) 常量、變量名及類名命名規(guī)范a. 常量命名規(guī)則：大寫英文字母加下劃線舉例：PRICE，MARKET_PRICEb. 變量命名變量類型類型簡(jiǎn)寫標(biāo)準(zhǔn)命名舉例ArrayarrarrShoppingList Boolean blnblnIsPostBackBytebytbytPixelValue CharchrchrDelimiterDateTime dtmdtmStartDateDecimaldecdecAverageHeight DoubledbldblSizeofUniverse GuidguguUserIDInteger

11、intintRowCounter Long lng lngBillGatesIncome Object obj objReturnValue Short shr shrAverage Single sng sngMaximum String str strFirstName c. 類命名1、類名命名：以該類的具體用途命名該類類名，全英文構(gòu)成，單個(gè)單詞首字母大寫，組合單詞每個(gè)單詞首字母大寫，其它字母小寫，例如：UserInfo，ProductDetails。2、頂級(jí)命名空間命名：例如：Test。3、類庫(kù)名空間命名：“Test”+“.”+類庫(kù)名，例如：Test.BLL。4、 類名空間命名：“Tes

12、t”+“.”+類庫(kù)名+類名，例如：Test.Model.DeptInfo。5) CSS命名規(guī)范樣式表文件名 命名規(guī)則，全英文構(gòu)成，單個(gè)單詞首字母大寫，組合單詞每個(gè)單詞首字母大寫，其它字母小寫，并以“Style”結(jié)尾，前面組合單詞指明該樣式表的用途，例如：HomePageStyle，表示應(yīng)用于主頁(yè)的全局樣式表；ProudctListStyle，表示應(yīng)用于產(chǎn)品列表的樣式表。a. CSS常用命名規(guī)范頭：header內(nèi)容：content/container尾：footer導(dǎo)航：nav側(cè)欄：sidebar欄目：column頁(yè)面外圍控制整體布局寬度：wrapper左右中：leftrightcenter登錄

13、條：loginbar標(biāo)志：logo廣告：banner頁(yè)面主體：main熱點(diǎn)：hot新聞：news下載：download子導(dǎo)航：subnav菜單：menu子菜單：submenu搜索：search友情鏈接：friendlink頁(yè)腳：footer版權(quán)：copyright滾動(dòng)：scroll內(nèi)容：content標(biāo)簽頁(yè)：tab文章列表：list提示信息：msg小技巧：tips欄目標(biāo)題：title加入：joinus指南：guild服務(wù)：service注冊(cè)：regsiter狀態(tài)：status投票：vote合作伙伴：partnerb. 注釋的寫法/*Footer*/內(nèi)容區(qū)/*EndFooter*/c. id的命

14、名(1)頁(yè)面結(jié)構(gòu)容器:container頁(yè)頭：header內(nèi)容：content/container頁(yè)面主體：main頁(yè)尾：footer導(dǎo)航：nav側(cè)欄：sidebar欄目：column頁(yè)面外圍控制整體布局寬度：wrapper左右中：leftrightcenter(2)導(dǎo)航導(dǎo)航：nav主導(dǎo)航：mainbav子導(dǎo)航：subnav頂導(dǎo)航：topnav邊導(dǎo)航：sidebar左導(dǎo)航：leftsidebar右導(dǎo)航：rightsidebar菜單：menu子菜單：submenu標(biāo)題:title摘要:summary(3)功能標(biāo)志：logo廣告：banner登陸：login登錄條：loginbar注冊(cè)：regsi

15、ter搜索：search功能區(qū)：shop標(biāo)題：title加入：joinus狀態(tài)：status按鈕：btn滾動(dòng)：scroll標(biāo)簽頁(yè)：tab文章列表：list提示信息：msg當(dāng)前的:current小技巧：tips圖標(biāo):icon注釋：note指南：guild服務(wù)：service熱點(diǎn)：hot新聞：news下載：download投票：vote合作伙伴：partner友情鏈接：link版權(quán)：copyrightd. class的命名(1)顏色：使用顏色的名稱或者16進(jìn)制代碼。如.redcolor:red;.f60color:#f60;.ff8600color:#ff8600;(2)字體大小，直接使用font

16、+字體大小作為名稱。如.font12pxfont-size:12px;.font9ptfont-size:9pt;(3)對(duì)齊樣式，使用對(duì)齊目標(biāo)的英文名稱。如.leftfloat:left;.bottomfloat:bottom;(4)標(biāo)題欄樣式，使用類別+功能的方式命名。如.barnews.barproducte. 注意事項(xiàng)1.一律小寫;2.盡量用英文；3.不加中杠和下劃線；4.盡量不縮寫，除非一看就明白的單詞。主要的MasterStyle.css模塊ModuleStyle.css基本共用BaseStyle.css布局，版面LayoutStyle.css主題ThemesStyle.css專欄C

17、olumnsStyle.css文字FontStyle.css表單FormsStyle.css補(bǔ)丁MendStyle.css打印PrintStyle.css4. 代碼書寫格式規(guī)范o 文件之中不得存在無(wú)規(guī)則的空行，比如說(shuō)連續(xù)十個(gè)空行。一般來(lái)講函數(shù)與函數(shù)之間的空行為2-3行。o 在函數(shù)體內(nèi)部，在邏輯上獨(dú)立的兩個(gè)函數(shù)塊可適當(dāng)空行，一般為1-2行。o 每行長(zhǎng)度盡量避免超過(guò)屏幕寬度，應(yīng)不超過(guò)80個(gè)字符。o 使用括號(hào)清晰地表達(dá)算術(shù)表達(dá)式和邏輯表達(dá)式的運(yùn)算順序。如將x=a*b/c*d 寫成 x=(a*b/c)*d可避免閱讀者誤解為x=(a*b)/(c*d)。o 避免采用過(guò)于復(fù)雜的條件測(cè)試。o 避免過(guò)多的循環(huán)嵌

18、套和條件嵌套。o 一個(gè)函數(shù)不要超過(guò)200行。一個(gè)文件應(yīng)避免超過(guò)2000行。o 不可以使用goto語(yǔ)句。o 避免采用多賦值語(yǔ)句，如x = y = z;。5. 代碼注釋規(guī)范1) .cs文件的注釋所有.cs文件開頭都要加上注釋，寫明文件創(chuàng)建時(shí)間、作者、用途概述等例如：/*/新增日期:2004.7.19/作者:XXX/內(nèi)容說(shuō)明:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/*2) 函數(shù)過(guò)程注釋所有的函數(shù)體開頭都要加上注釋，所以注釋使用.NET注釋規(guī)范。例如：/ / 構(gòu)造函數(shù)/ / 示例參數(shù)1/ 示例參數(shù)2public UpgradeThread(string is_xxx1, s

19、tring is_xxx2)/3) 常量變量注釋所有的常量變量，無(wú)論是全局還是局部使用的，凡是對(duì)代碼整體起到關(guān)鍵性做用的都需要加上注釋。例如：/ / 當(dāng)前線程指向的備份文件本地保存路徑/ public string strStorePath = ;4) 代碼修改注釋當(dāng)開發(fā)者維護(hù)以前的程序代碼時(shí)，需要在修改處的開始及結(jié)尾，加上自己的注釋信息。例如：/BEGIN 2004-7-19 Jayson修正了XXX問(wèn)題略/END 2004-7-19 Jayson注釋量化標(biāo)準(zhǔn)：注釋占代碼量的10%及以上附錄一：.NET中的命名規(guī)范名稱空間的命名 命名名稱空間的一般規(guī)則如下： CompanyName.Tech

20、nologyName這樣，我們看到的名稱空間應(yīng)該是這樣的：Microsoft.Office PowerSoft.PowerBuilder 注意：這只是一個(gè)原則。第三方公司可以選擇其它的名字。避免用公司名稱或其它著名品牌的名稱作為名稱空間的前綴，這樣會(huì)造成兩個(gè)公布的名稱空間有同一個(gè)名稱的可能性。例如：將微軟提供的Office自動(dòng)類命名為Microsoft.Office使用Pascal大寫方式，用逗號(hào)分隔邏輯成分。例如：Microsoft.Office.PowerPoint如果你的品牌使用的是非傳統(tǒng)大寫方式，那么一定要遵循你的品牌所確定使用的大寫方式，即使這種方式背離了通常的名稱空間大寫規(guī)則。例如

21、：NeXT.WebObjectsee.cummings類和類成分的命名類的命名原則是用名詞或名詞短語(yǔ)命名類，使用Pascal大寫。減少類名中縮寫的使用量。不要使用任何類前綴（比如C），不要使用帶下劃線的字符。例如：public class FileStream public class Button public class String 變量的命名名稱中各單詞首字母均為大寫。例如：FindLastRecordRedrawMyForm在內(nèi)部范圍中避免使用與外部范圍中的名稱相同的名稱。若訪問(wèn)錯(cuò)誤變量，則會(huì)產(chǎn)生錯(cuò)誤結(jié)果。若變量與同一名稱的關(guān)鍵字沖突，則必須在關(guān)鍵字前加適當(dāng)?shù)念愋蛶?kù)以作標(biāo)識(shí)。例如：若

22、有一個(gè)名為 date 的變量，只能通過(guò)調(diào)用System.Date來(lái)使用內(nèi)部Date函數(shù)。函數(shù)和方法的命名函數(shù)和方法的命名應(yīng)該以動(dòng)詞開始，使用Pascal大寫。不要使用帶下劃線的字符。例如：InitNameArrayCloseDialog接口命名原則使用名詞或名詞短語(yǔ)，或者描述行為的形容詞來(lái)命名接口,使用Pascal大寫。 減少接口名中縮寫的使用量，在接口名前加前綴I，以表示這個(gè)類型是一個(gè)接口。例如：IComponent（描述性名詞） ICustomAttributeProvider（名詞短語(yǔ)） IPersistable（形容詞）參數(shù)的命名使用描述性參數(shù)名。參數(shù)名應(yīng)該具有足夠的描述性，這樣在大多數(shù)情況下參數(shù)名和它的種類可以用來(lái)確定它的意思。根據(jù)參數(shù)的意思來(lái)命名參數(shù)，而不是根據(jù)參數(shù)的種類來(lái)命名。我們希望開發(fā)工具可以用很方便的方式提供關(guān)于參數(shù)種類的信息，這樣參數(shù)名可