C#編碼標準（上）

1．避免在同一個文件中放置多個類

2．一個文件應該只在一個名稱空間內定義類型，避免在一個文件中使用多個名稱空間

3．避免在一個文件內寫多于500行的代碼（機器自動生成的代碼除外）

4．避免寫超過25號代碼的方法

5．避免寫超過5個參數(shù)的方法。如果要傳遞多個參數(shù)，使用結構。

6．一行不要超過80個字符

7．不要手動去修改任何機器生成的代碼

a）如果修改了機器生成的代碼，修改你的編碼方式來使用這個編碼標準

b）盡可能使用partial classes特征，以提高可維護性（C#2.0新特性）

8．避免對那些很直觀的內容作注釋。代碼本身應該能夠解釋其自身的含義。由可讀的變量名和方法名構成的優(yōu)質代碼應該不需要注釋。

9．注釋應該只說明操作的一些前提假設、算法的內部信息等內容

10．避免對方法進行注釋

a）使用充足的外部文檔對API進行說明

b）只有對那些其他開發(fā)者的提示信息才有必要放到方法級的注釋中來

11．除了0和1，絕對不要對數(shù)值進行硬編碼，通過聲明一個常量來代替該數(shù)值

12．只對那些亙古不變的數(shù)值使用const關鍵字，例如一周的天數(shù)

13．避免對只讀（read-only）的變量使用const關鍵字。在這種情況下，直接使用readonly關鍵字

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

14．對每一個假設進行斷言。平均起來，每5行應有一個斷言

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

15．每一行代碼都應該以白盒測試的方式進行審讀

16．只捕捉那些你自己能夠顯式處理的異常

17．如果在catch語句塊中需要拋出異常，則只拋出該catch所捕捉到異常（或基于該異常而創(chuàng)建的其它異常），這樣可以維護原始錯誤所在的堆棧位置；

catch（Exception exception）  
{  
    MessageBox.Show(exception.Mesage);  
    throw; //或throw,exception;  
} 

18．避免利用返回值作為函數(shù)的錯誤代碼

19．避免自定義異常類

20．當自定義異常類的時候

a）讓你自定義的異常類從Execption類繼承

b）提供自定義的串行化機制

21．避免在一個程序集（assembly）中定義多個Main()方法

22．只把那些絕對需要的方法定義成public，而其它的方法定義成internal

23．避免friend assemblies，因為這會增加程序集之間的偶合性

24．避免讓你的代碼依賴于運行在某個特定地方的程序集

C#編碼標準（中）

25．在application assembly (EXE client assemblies)中最小化代碼量，使用類庫來包含業(yè)務邏輯

26．避免顯示指定枚舉的值

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

27．避免為枚舉指定一個類型

//避免  
public enum Color：long 
{  
    Red, Grenn, Blue  
} 

28．對于if語句，總使用一對{}把下面的語句塊包含起來，哪怕只有一條語句也是如此

29．避免使用三元條件操作符

30．避免利用函數(shù)返回的Boolean值作為條件語句。把返回值賦給一個局部變量，然后再檢測

bool IsEverythingOK()  
{…}  
//避免  
if (IsEverythingOK) {…}  
//正確  
bool ok = IsEverythingOK()  
if (ok) {…} 

31．總是使用以零為基數(shù)的數(shù)組

32．總是使用一個for循環(huán)顯式的初始化一個引用成員的數(shù)組

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

33．使用屬性來替代public或protected類型的成員變量

34．不要使用繼承下來的new操作符，使用override關鍵字覆寫new的實現(xiàn)

35．在一個非密封（non-sealed）類中，總是把那些public和protected的方法定義成virtual

36．除非為了和其他語言進行互動，否則絕不要使用不安全（unsafe）的代碼

37．避免顯示類型轉換。使用as關鍵字安全的轉換到另一個類型

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

38．在調用一個代理前，總是檢查它是否為null

39．不要提供public的事件成員變量。改用Event Accessor

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

40．避免定義事件處理代理。使用EventHandler或者GenericEventHandler。其中GenericEventHandler定義在《Programming .NET components》2/e第6章

41．避免顯示出發(fā)事件。使用EventsHelper安全的發(fā)布事件。EnentHelper定義在《Programming .NET components》2/e第6~8章中

42．總是使用接口

43．接口和類中方法和屬性的比應該在2：1左右

44．避免只有一個成員的接口

45．努力保證一個接口有3-5個成員

46．不要讓一個接口中成員的數(shù)量超過20個，而12則是更實際的限制

47．避免在接口中包含事件

48．當使用抽象類的時候，提供一個接口

C#編碼標準（下）

49．在類繼承結構中暴露接口

50。推薦使用顯式接口實現(xiàn)

51．從來不要假設一個類型支持某個接口。在使用前總是要詢問一下

SomeType obj1;  
IMyInterface obj2  
/* Some code to initialize obj1, then; */ 
obj2 = obj1 as IMyInterface;  
if (obj2 != null)  
{  
    obj2.Method1();  
}  
else 
{  
    //Handle error in expected interface  
} 

52．不要硬編碼向用戶顯示字符串。要使用資源

53．不要硬編碼那些可能會隨發(fā)布環(huán)境變化而變化的字符串，例如數(shù)據(jù)庫連接字符串

54．使用String.Empty取代“”

//避免  
tring name = “”;  
//正確  
tring name = String.Empty; 

55．用一個長字符串的時候，使用StringBuiler代替string

56．避免在結構中提供方法

a）參數(shù)化的構造函數(shù)是鼓勵使用的

b）可以重載運算符

57．當聲明了靜態(tài)成員的時候，總是要提供一個靜態(tài)構造函數(shù)

58．當早綁定（early-binding）可能的時候就盡量不要使用遲綁定（late-binding）

59．讓你的應用程序支持跟蹤和調試

60．除了要在switch語句塊中實現(xiàn)代碼跳轉，不要使用goto關鍵字

61．總在switch語句的default情形提供一個斷言

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

62．除了在一個構造函數(shù)中調用其它的構造函數(shù)之外，不要使用this關鍵字

//Example of proper use of ‘this’  
public class MyClass  
{  
    public MyClass(string message) {…}  
    public MyClass(): this(“Hello”) {…}  
} 

63．不要使用base關鍵字訪問基類的成員，除非你在調用一個函數(shù)的時候要決議一個子類的名稱沖突

//Example of proper use of ‘base’  
 public class Dog  
 {  
     public Dog(stinrg name) {…}  
     virtual public void Bark(int howLong) {…}  
 }  
 public class GermanShepherd：Dog  
 {  
     public GermanShepherd(string name)：base(name) {…}  
     override public void Brak(int howLong)  
     {  
         base.Brak(howlong);  
     }  
 } 

64．不要使用GC.AddMemoryPressure()

65．不要依賴HandleCollector

66．基于《Programming .NET components》2/e中第4章內容實現(xiàn)Dispose()和Finalize()方法

67．總是在unchecked狀態(tài)下運行代碼（出于性能的原因），但是為了防止溢出或下溢操作，要果斷地使用checked模式

int CalcPower(int number, int power)  
{  
    int result = 1;  
    for (int count = 1; count < = power; count++)  
    {  
        checked 
        {  
            result *= number;  
        }  
    }  
    return result;  
} 

68．使用條件方法來取代顯式進行方法調用排除的代碼（#if…#endif）

public class MyClass  
{  
    [Conditional(“MySpecialCondition”)]  
    public void MyMethod() {…}  
} 

69．不要在泛型接口中定義約束。接口級的約束通常可以利用強類型來替代

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

70．不要在接口上定義方法相關的約束

71．不要再代理上定義約束

72．如果一個類或方法提供了泛型和非泛型版本，那么優(yōu)先選擇泛型版本

【編輯推薦】

1. C#實現(xiàn)多語言界面程序的方法介紹
2. 介紹C#構造函數(shù)的使用方法
3. C#多態(tài)性的概念及其應用
4. 淺析C# treeview控件的使用方法
5. 總結C#獲取當前路徑的7種方法