C#編碼規(guī)范(完整資料).doc

1、C#編碼規(guī)范第12/12頁(yè)【最新整理，下載后即可編輯】1程序結(jié)構(gòu)所有源代碼的結(jié)構(gòu)均采用以下順序布局，對(duì)于沒(méi)有的部分可以省略, 便于閱讀代碼。上三三三三三三三三三三尋三二三三三二#rcdon Constant#eridreion Constant#reon Members#endreion Members#rcyion Defaults#cridreion Defaults#recoil Properties#cnarexion Properties#re$>ion Constructors#cridrexion Constructors #reyjon InterfaceMethods#

2、eridreion InterfaceMethods#redon StaticMethods#endreion StaticMethods#region ( )vcrridcMethods#cridreion OverrideMethods#reion PrivateMethods#cnarexion PrivateMethods#redon ProtectedMethods#eridreion ProtectedMethods#redon PublicMethods#enarexion PublicMethods#redon Events#enarexion Events2命名規(guī)則和風(fēng)格 類

3、、方法、常量采用Pascal風(fēng)格命名 public class SomcClassconst int DefaultSizc = 10();public SomeMcthodO成員變量采用Camel風(fēng)格命名，但前面加一個(gè)底劃線 public class SomeClassint _port 二 5000;public SomeMcthodO局部變量和方法參數(shù)采用Camel風(fēng)格命名 public class SomeClasspublic SomeMethod(int len)string sLinc; 接口采用I作為前綴命名interface IMylntcrface(5)自定義厲性類型以Am

4、作為后綴命名自定義異常類型以Ex作為后綴命名 采用動(dòng)名詞命名方法，例如ShowDialogO(8) 有返回值的方法的命名應(yīng)該能夠描述其返回值，例如 Gct()bjcctStatc()(9) 采用描述性的變量名。a) 避免采用單字母的變量名，如i或t；而是采用indux或tempb) 對(duì)public和protected成員避免采用用匈牙利命名法，如：采用Port 不用 nPort,c) 盡量不要采用縮寫(xiě)(例如將number縮寫(xiě)為num)(10) 總是使用C#預(yù)定義的類型，而不是使用System命名空間中的別名 【最新整理，下載后即可編輯】氣心C#編碼規(guī)范第12/12頁(yè)例如：采用object不用O

5、bject 采用string不用String 采用int不用Int32(11) 對(duì)于泛型類型采用大寫(xiě)宇母。當(dāng)處理.NET類型的Type時(shí)保留其后 綴 Type、pubdc ”忽 UnkcdList<K,T>器目LinkedList<KeyType,DataType>(12) 采用有意義的命名空間名，例如產(chǎn)品名稱或公司名稱(13) 避免使用類的全稱，而是采用using聲明(14) 避免在命名空間內(nèi)使用using語(yǔ)句(15) 把所有系統(tǒng)框架提供的名稱空間組織到一起，把第三方提供的名稱 空間放到系統(tǒng)名稱空間的下面usin System;usin Systcm.Collccti

6、on.Gcncric;using Systcm.ComponcntModcl;usin Svstcm.Data;usinir MyCompany;using MyControls;(16) 使用代理推導(dǎo)而不要顯式的實(shí)例化一個(gè)化代理(C#2.0新特性) delegate void SomcDclctratcO;public void SomcMcthoaOSomcDclcgate somcDclcgatc=SomcMcthod;(17) 使用sb縮進(jìn)，縮進(jìn)4個(gè)空格(18) 總是把花括號(hào)“”和“”獨(dú)立放在新的一行(19) 一個(gè)文件名應(yīng)該能夠反映它所對(duì)應(yīng)的類名3編碼實(shí)踐1. 避免在同一個(gè)文件中放置多

7、個(gè)類2. 避免在一個(gè)文件內(nèi)寫(xiě)多于5()()行的代碼(機(jī)器自動(dòng)生成的代碼除外) 3避免寫(xiě)超過(guò)25行代碼的方法4. 避免寫(xiě)超過(guò)5個(gè)參數(shù)的方法，如果要傳遞多個(gè)參數(shù)，使用結(jié)構(gòu)5. 運(yùn)算符的兩邊均應(yīng)插入一個(gè)空格，便于閱讀代碼6. 注釋時(shí)，在注釋符號(hào)后面插入一個(gè)空格，便于閱讀代碼 /自定義類【最新整理，下載后即可編輯】7. 不要手動(dòng)去修改任何機(jī)器生成的代碼勾如果修改了機(jī)器生成的代碼，修改你的編碼方式來(lái)適應(yīng)這個(gè)編 碼標(biāo)準(zhǔn)b)盡可能使用partial classes特性,以提高可維護(hù)性。(C#2.0新特 性)&避免對(duì)那些很直觀的內(nèi)容作注釋，代碼本身應(yīng)該能夠解釋其本身的 含義。由可讀的變量名和方法名構(gòu)成

8、的優(yōu)質(zhì)代碼應(yīng)該不需要注釋9.注釋?xiě)?yīng)該只說(shuō)明操作的一些前提假設(shè)、算法的內(nèi)部信息等內(nèi)容 1().避免對(duì)方法進(jìn)行注釋勾使用充足的外部文檔對(duì)API進(jìn)行說(shuō)明b)只有對(duì)那些其他開(kāi)發(fā)者的提示信息才有必要放到方法級(jí)的注釋 中來(lái)11. 除了()和1,絕對(duì)不要對(duì)數(shù)值進(jìn)行硬編碼，通過(guò)聲明一個(gè)常量來(lái)代 替該數(shù)值12. 只對(duì)那些亙古不變的數(shù)值使用const關(guān)鍵宇，例如一周的天數(shù)13. 避免對(duì)只讀(read-only)的變量使用const關(guān)鍵宇。在這種情況下，直 接使用readonly關(guān)鍵宇public class MyClasspublic const int DaysInWcek 二 7;pubic readonly

9、 int Number;public MyClass(int someValue) Number=someValue;14對(duì)每一個(gè)假設(shè)進(jìn)行斷言。平均起來(lái)，每5行應(yīng)有一個(gè)斷言 using Svstcm.Diaiostics;object GctObjectQ ；object somcObjcct = GctObjectQ； Debug.assert(some()bjcct != null);15. 每一行代碼都應(yīng)該以白盒測(cè)試的方式進(jìn)行審讀16. 只捕捉那些你自己能夠顯式處理的異常17. 如果在catch語(yǔ)句塊中需要拋出異常，則只拋出該catch所捕捉到的【最新整理，下載后即可編輯】04” C#編

10、碼規(guī)范第12/12頁(yè)異常(或基于該異常而創(chuàng)建的其他異常)，這樣可以維護(hù)原始錯(cuò)誤所在的堆 棧位置catch(Exccption ex)McssaeBox.Show(cx.Mcssac); throw; 或 throw exception;18避免利用返回值作為函數(shù)的錯(cuò)誤代碼19.避免自定義異常類2().當(dāng)自定義異常類的時(shí)候a) 讓你自定義的異常類從Exception類繼承b) 提供自定義的串行化機(jī)制23. 避免friend assemblies,因?yàn)檫@會(huì)增加程序集之間的耦合性24. 避免讓你的代碼依賴于運(yùn)行在某個(gè)特定地方的程序集25. 在 application asscmbly(EXE cli

11、ent assemblies)中最小化代碼量。使用 類庫(kù)來(lái)包含業(yè)務(wù)邏輯26. 避免顯式指定枚舉的值 public 型um Color卜 Red,Green,Blue品免r ipublic enum ColorRed = 1, Green = 2, Blue = 329.避免使用三元條件操作符3().避免利用函數(shù)返回的Boolean值作為條件語(yǔ)句。把返回值賦給一個(gè)局部變量，然后再檢測(cè)Bool IsEvurything)K()礙皿0)正確bool ok=IsEver5rthino< )K0；if (ok)31總是使用以零為基數(shù)的數(shù)組32. 總是使用一個(gè)for循環(huán)顯式的初始化一個(gè)引用成員的數(shù)組

12、 public class MyClassconst int ArraySizc= 10();MyClassf array=new MvClass ArravSizc;For (int index=();indcx< array. Length;inacx+) array|index=new MyClassO；33. 使用屬性來(lái)替代public或protected類型的成員變量34. 不要使用繼承下來(lái)的new操作符，使用override關(guān)鍵宇覆寫(xiě)new的 實(shí)現(xiàn)37. 避免顯示類型轉(zhuǎn)換。使用as關(guān)鍵字安全的轉(zhuǎn)換到另一個(gè)類型 Dog do£y = new GermanShepher

13、dO；GermanShepherd shepherd = dog as GermanShepherd;if (shepherd != null)38. 在調(diào)用一個(gè)代理前，總是檢查它是否為null39. 不要提供public的事件成員變量。改用Event Accessor Public class MvPublisherMyDclcytc m_SomcEvent;Public event MyDcley；atc SomcEventaddm_SomcEvcnt+ =valuc;removem_SomcEvcnt-=valuc;40. 避免定義事件處理代理。使用 EvcntHandler<T&

14、gt;或者 GcnericEvcntHandlcr41. 避免顯示觸發(fā)事件。使用EvcntsHelper安全的發(fā)布事件42. 總是使用接口43. 接口和類中方法和屬性的比應(yīng)該在2:1左右44. 避免只有一個(gè)成員的接口45. 努力保證一個(gè)接口有35個(gè)成員46. 不要讓一個(gè)接口中成員的數(shù)量超過(guò)2(),而12則是更為實(shí)際的限制47. 避免在接口中包含事件【最新整理，下載后即可編輯】氣心C#編碼規(guī)范第12/12頁(yè)4&當(dāng)使用抽象類的時(shí)候，提供一個(gè)接口49.在類繼承結(jié)構(gòu)中暴露接口5().推薦使用顯式接口實(shí)現(xiàn)51.從來(lái)不要假設(shè)一個(gè)類型支持某個(gè)接口。在使用前總是要詢問(wèn)一下 SomcTypu objl;

15、Imylnterfacc obj2;/ Some code to initialize objl,thcn:obj2 二 objl as Imylnterfacc;if(obj2 匸 null)obj 2.Method 1();else/ Handle erro in expected interface53.不要硬編碼那些可能會(huì)隨發(fā)布環(huán)境變化而變化的字符串，例如數(shù)據(jù) 庫(kù)連接字符串54使用String.Empty取代心/.避免 OTC 二.； string name 二 String.Empty;55. 使用一個(gè)超過(guò)8()宇符禹長(zhǎng)宇符串的時(shí)候，使用StringBuilder代替 string5

16、6. 避免在結(jié)構(gòu)中提供方法a) 參數(shù)化的構(gòu)造函數(shù)是鼓勵(lì)使用的b) 可以重載運(yùn)行符58. 當(dāng)早綁定(early-binding)可能的時(shí)候就盡量不要使用遲綁定 (late-binding)59. 讓你的應(yīng)用程序支持跟蹤和日志61. 總在switch語(yǔ)句的default情形提供一個(gè)斷言int number 二 SomcMcthodO; swith(numbcr)case 1:“”trace.WritcLine( Case 1:)break;case 2:“”trace.Writeline( Case 2:);break;default:dcbu.Assert(falsc); break;【最新整理

17、，下載后即可編輯】C#編碼規(guī)范第12/12頁(yè)62. 除了在一個(gè)構(gòu)造函數(shù)中調(diào)用其它的構(gòu)造函數(shù)之外，不要使用this關(guān)鍵字【最新整理，下載后即可編輯】/ Example of proper use of 'this' public class MyClasspublic MyClass(string message) public MyClass():this( “Hello")63. 不要使用base關(guān)鍵字訪問(wèn)基類的成員，除非你在調(diào)用一個(gè)基類構(gòu)造 函數(shù)的時(shí)候要決議一個(gè)子類的名稱沖突/ Example of proper use of ase1 public class

18、Do乂public Dotstrin name)( f.virtual public void Bark(int howlonpublic class GcrmanShcphcrd:Do;public GcrmanShephcrd(strino； namc):base(name)override public void Bark(int howLon basc.Bark(howLont66.基于Programming .NET components2/e中第四章的內(nèi)容實(shí)現(xiàn) Disponse0 和 FinalizeO 方法67.總是在unchecked狀態(tài)下運(yùn)行代碼（出于性能的原因），但是為了防

19、 止溢出或下溢操作，要果斷地使用cheeked模式Int CalcPower(int numberint power)int result=l;for (int count=l ;count<=power;count+) checkedresult* 二 number;return result;6&使用條件方法來(lái)取代顯式進(jìn)行方法調(diào)用排除的代碼4控件命名4.1數(shù)據(jù)類型命名數(shù)據(jù)類型數(shù)據(jù)類型簡(jiǎn)寫(xiě)標(biāo)準(zhǔn)命名舉例BooleanbblsPostBackIntegernnRowCountcrLong1IPosSingleffMaxXDoubleddMaxV alucCharccDclimite

20、rStringssFirstNamcDatcTimedtdtStartDatcByteJbvtJbvtPixelV alucJDecimaldecdccAveragcHeightShortshtsht A verageObjectobjobjRcturnValueArray后面加sstudentsArrayList前面加arrayarravStudcntJList前面加listlistStudcnt4.2 Win控件命名控件類型控件類型簡(jiǎn)寫(xiě)標(biāo)準(zhǔn)命名舉例LabellbllblMcssagcLinkLabclllblllblTodayButtonbtnb tnSaveTextBoxtxttxtNa

21、meMainMcnumnmnFilcMcnultcmmimiFilcOpcnPopupMcnupmpmPrintChcckBoxchkchkStockRadioButtonrdordoSclcctcdjaAC#編碼規(guī)范第12/12頁(yè)GroupBoxgbogboMainPicturcBoxpicpiclmagePanelpnlpnlBodyDataGridgrdgrdVicwListBox1stIstProductsCheckedListBox1stIstChcckcdComboBoxcbocboMcnuListVicwlvwlvwBrowsurTree ViewtvwtvwTypuTabCon

22、trolctlctlSegy-InfoTabPageTabtabTracklnfoDatcTimePickcrdtpdtpS tar tD ateHscrollBarhsbhsblmagcVscrollBarvsbvsblmagcTimertimtimCountImageListimgimgListToolBardbtlbManageStatusBarstbstbFootPrintOpenFileDialogdigdlgOpcnSaveFilcDialogdigdlgSaveFoldBrowserDialogdigdlgBrowscrFontDialogdigdlgFontColorDialo

23、gdigdlgColorPrintDialogdigdlgPrint43 Web控件命名控件類型控件類型簡(jiǎn)寫(xiě)標(biāo)準(zhǔn)命名舉例AdRotatoradrtExampleButtonbtnbtnSubmitCalendarcalcalMcttingDatesChcckBoxchkchkBlueChcckBoxListchklchklFaxColorsCompare V alidatorvalevale Valid AgeCustomValidatorvalxvalxDBChcckDataGriddgrddgrdTitlesDataListdlstdlstTitlesDropDownListdropdropCountricsHyperLinkInkInkDetailsImageimgimgAuntBettyImagcButtonibtnibtnSubmitLabellbllblRcsultsLinkButtonlbtnIbtnSubmitListBox1stIstCountricsPanelpnlpnlForm2PlaccHoldcrplhplhForm