C#中的編碼標(biāo)準(zhǔn)有哪些

這篇文章主要為大家展示了“C#中的編碼標(biāo)準(zhǔn)有哪些”，內(nèi)容簡(jiǎn)而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領(lǐng)大家一起研究并學(xué)習(xí)一下“C#中的編碼標(biāo)準(zhǔn)有哪些”這篇文章吧。

1.  避免將多個(gè)類(lèi)放在一個(gè)文件里面。

2.  一個(gè)文件應(yīng)該只有一個(gè)命名空間，避免將多個(gè)命名空間放在同一個(gè)文件里面。

3.  一個(gè)文件***不要超過(guò)500行的代碼（不包括機(jī)器產(chǎn)生的代碼）。

4.  一個(gè)方法的代碼長(zhǎng)度***不要超過(guò)25行。

5.  避免方法中有超過(guò)5個(gè)參數(shù)的情況。使用結(jié)構(gòu)來(lái)傳遞多個(gè)參數(shù)。

6.  每行代碼不要超過(guò)80個(gè)字符。

7.  不要手工的修改機(jī)器產(chǎn)生的代碼。

a)  如果需要編輯機(jī)器產(chǎn)生的代碼，編輯格式和風(fēng)格要符合該編碼標(biāo)準(zhǔn)。

b)  Use partial classes whenever possible to factor out the maintained portions.

8.  避免利用注釋解釋顯而易見(jiàn)的代碼。

a)  代碼應(yīng)該可以自解釋。好的代碼由可讀的變量和方法命名因此不需要注釋。

9.  Document only operational assumptions, algorithm insights and so on.  

10.  避免使用方法級(jí)的文檔。

a)  使用擴(kuò)展的API文檔說(shuō)明之。

b)  只有在該方法需要被其他的開(kāi)發(fā)者使用的時(shí)候才使用方法級(jí)的注釋。（在C#中就是///）

11.  不要硬編碼數(shù)字的值，總是使用構(gòu)造函數(shù)設(shè)定其值。

12.  只有是自然結(jié)構(gòu)才能直接使用const，比如一個(gè)星期的天數(shù)。

13.  避免在只讀的變量上使用const。如果想實(shí)現(xiàn)只讀，可以直接使用readonly。

public class MyClass    {       public readonly int Number;       public MyClass(int  someValue)       {          Number = someValue;       }       public  const int  DaysInWeek = 7;    }

14.  每個(gè)假設(shè)必須使用Assert檢查

a)  平均每15行要有一次檢查(Assert)

using System.Diagnostics;    object GetObject()    {…}    object obj = GetObject();    Debug.Assert(obj != null);

15.  代碼的每一行都應(yīng)該通過(guò)白盒方式的測(cè)試。

16.  只拋出已經(jīng)顯示處理的異常。

17.  在捕獲(catch)語(yǔ)句的拋出異常子句中(throw)，總是拋出原始異常維護(hù)原始錯(cuò)誤的堆棧分配。

catch(Exception exception)    {          MessageBox.Show(exception.Message);       throw ;  //和throw exception一樣。    }

18.  避免方法的返回值是錯(cuò)誤代碼。

19.  盡量避免定義自定義異常類(lèi)。

20.  當(dāng)需要定義自定義的異常時(shí)：

a)  自定義異常要繼承于ApplicationException。

b)  提供自定義的序列化功能。

21.  避免在單個(gè)程序集里使用多個(gè)Main方法。

22.  只對(duì)外公布必要的操作，其他的則為internal。

23.  Avoid friend assemblies, as it increases inter-assembly coupling.

24.  Avoid code that relies on an assembly running from a particular location.

25.  使應(yīng)用程序集盡量為最小化代碼(EXE客戶(hù)程序)。使用類(lèi)庫(kù)來(lái)替換包含的商務(wù)邏輯。

26.  避免給枚舉變量提供顯式的值。

//正確方法     public enum Color    {          Red,Green,Blue    }    //避免   public enum Color    {          Red = 1,Green =  2,Blue = 3    }

27.  避免指定特殊類(lèi)型的枚舉變量。

//避免     public enum Color  : long    {          Red,Green,Blue    }

28.  即使if語(yǔ)句只有一句，也要將if語(yǔ)句的內(nèi)容用大括號(hào)擴(kuò)起來(lái)。

29.  避免使用trinary條件操作符。

30.  避免在條件語(yǔ)句中調(diào)用返回bool值的函數(shù)?？梢允褂镁植孔兞坎z查這些局部變量。

bool IsEverythingOK()    {…}    //避免    if (IsEverythingOK ())    {…}    //替換方案     bool ok = IsEverythingOK();    if (ok)    {…}

31.  總是使用基于0開(kāi)始的數(shù)組。

32.  在循環(huán)中總是顯式的初始化引用類(lèi)型的數(shù)組。

public class MyClass    {}    MyClass[] array = new  MyClass[100];    for(int index = 0; index <  array.Length;  index++)    {       array[index] = new  MyClass();    }

33.  不要提供public 和 protected的成員變量，使用屬性代替他們。

34.  避免在繼承中使用new而使用override替換。

35.  在不是sealed的類(lèi)中總是將public 和 protected的方法標(biāo)記成virtual的。

36.  除非使用interop(COM+ 或其他的dll)代碼否則不要使用不安全的代碼(unsafe code)。

37.  避免顯示的轉(zhuǎn)換，使用as操作符進(jìn)行兼容類(lèi)型的轉(zhuǎn)換。

Dog dog = new GermanShepherd();    GermanShepherd shepherd = dog  as  GermanShepherd;    if (shepherd != null )    {…}

38.  當(dāng)類(lèi)成員包括委托的時(shí)候

a)  Copy a delegate to a local variable before publishing to avoid concurrency race

condition. 

b)  在調(diào)用委托之前一定要檢查它是否為null

public class MySource    {       public event EventHandler  MyEvent;       public void FireEvent()       {          EventHandler temp = MyEvent;          if(temp != null )          {             temp(this,EventArgs.Empty);          }       }    }

39.  不要提供公共的事件成員變量，使用事件訪問(wèn)器替換這些變量。

public class MySource    {       MyDelegate m_SomeEvent ;       public event MyDelegate SomeEvent       {          add          {             m_SomeEvent += value;          }          remove          {             m_SomeEvent -= value;          }       }    }

40.  使用一個(gè)事件幫助類(lèi)來(lái)公布事件的定義。

41.  總是使用接口。

42.  類(lèi)和接口中的方法和屬性至少為2:1的比例。

43.  避免一個(gè)接口中只有一個(gè)成員。

44.  盡量使每個(gè)接口中包含3－5個(gè)成員。

45.  接口中的成員不應(yīng)該超過(guò)20個(gè)。

a)  實(shí)際情況可能限制為12個(gè)

46.  避免接口成員中包含事件。

47.  避免使用抽象方法而使用接口替換。

48.  在類(lèi)層次中顯示接口。

49.  推薦使用顯式的接口實(shí)現(xiàn)。

50.  從不假設(shè)一個(gè)類(lèi)型兼容一個(gè)接口。Defensively query for that interface.

SomeType obj1;

IMyInterface obj2;

/* 假設(shè)已有代碼初始化過(guò)obj1，接下來(lái) */    obj2 = obj1 as IMyInterface;    if (obj2 != null)    {       obj2.Method1();    }    else    {       //處理錯(cuò)誤    }

51.  表現(xiàn)給最終用戶(hù)的字符串不要使用硬編碼而要使用資源文件替換之。

52.  不要硬編碼可能更改的基于配置的字符串，比如連接字符串。

53.  當(dāng)需要構(gòu)建長(zhǎng)的字符串的時(shí)候，使用StringBuilder不要使用string

54.  避免在結(jié)構(gòu)里面提供方法。

a)  建議使用參數(shù)化構(gòu)造函數(shù)

b)  可以重裁操作符

55.  總是要給靜態(tài)變量提供靜態(tài)構(gòu)造函數(shù)。

56.  能使用早期綁定就不要使用后期綁定。

57.  使用應(yīng)用程序的日志和跟蹤。

58.  除非在不完全的switch語(yǔ)句中否則不要使用goto語(yǔ)句。

59.  在switch語(yǔ)句中總是要有default子句來(lái)顯示信息(Assert)。

int number  = SomeMethod();    switch(number)    {       case 1:          Trace.WriteLine("Case 1:");          break;       case 2:          Trace.WriteLine("Case 2:");          break;       default :          Debug.Assert(false);          break;    }

60.  除非在構(gòu)造函數(shù)中調(diào)用其他構(gòu)造函數(shù)否則不要使用this指針。

// 正確使用this的例子    public class MyClass    {       public MyClass(string message )       {}       public MyClass()  : this("hello")       {}    }

61.  除非你想重寫(xiě)子類(lèi)中存在名稱(chēng)沖突的成員或者調(diào)用基類(lèi)的構(gòu)造函數(shù)否則不要使用base來(lái)訪問(wèn)基類(lèi)的成員。

// 正確使用base的例子   public class Dog    {       public Dog(string name)       {}       virtual public void Bark( int howLong)       {}    }    public class GermanShepherd : Dog    {       public GermanShe pherd(string name): base (name)       {}       override public void Bark(int  howLong)        {          base .Bark(howLong);         }    }

62.  基于模板的時(shí)候要實(shí)現(xiàn)Dispose()和Finalize()兩個(gè)方法。

63.  通常情況下避免有從System.Object轉(zhuǎn)換來(lái)和由System.Object轉(zhuǎn)換去的代碼，而使用強(qiáng)制轉(zhuǎn)換或者as操作符替換。

class SomeClass    {}    //避免：    class MyClass< T>     {          void SomeMethod(T t)          {          object temp = t;                SomeClass obj = (SomeClass)temp;           }    }    // 正確：    class MyClass< T> where T : SomeClass    {          void SomeMethod(T t)          {          SomeClass obj = t;          }    }

64.  在一般情況下不要定影有限制符的接口。接口的限制級(jí)別通?？梢杂脧?qiáng)類(lèi)型來(lái)替換之。

public class Customer    {…}    //避免：   public interface IList< T> where T : Customer     {…}    //正確：   public interface ICustomerList : IList< Customer>     {…}

65.  不確定在接口內(nèi)的具體方法的限制條件。

66.  總是選擇使用C#內(nèi)置（一般的generics）的數(shù)據(jù)結(jié)構(gòu)。

以上是“C#中的編碼標(biāo)準(zhǔn)有哪些”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對(duì)大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！