C#代碼標準——命名規範

       命名規範是我們在寫代碼之前首先要確定好的。本文是在IDesign(www.idesign.net)在網上流傳的一份文檔(C# coding standard version 2.1)的基礎上完成的。

    使用命名規範的好處：

    在代碼大全II中，作者闡述了許多條命名規範帶來的好處：

l         要求你更多地按規矩行事。通過做一項全域決策而不是做許多局部決策，你可以集中精力關注代碼更重要的特徵。

l         有助於在項目之間傳遞知識。名字的相似效能讓你理容易、更自信地理解那些不熟悉的變數原本應該做什麼的。

l         有助於你在新項目中更快地學習代碼。你無須瞭解其他組員代碼中是什麼樣的規範，而只須面對一組更加一致的代碼。

l         有助於減少名字增生。在沒有命名規則的情況下，會很容易給同一個對象起兩個不同的名字。這會讓閱讀這段代碼的人感到困惑。

l         彌補程式設計語言的不足之處。

l         強調相關變數之間的關係。

       關鍵在於，採用任何一項規則都要好於沒有規則。規則的存在為你的代碼增加了結構，減少了你需要考慮的事情。

       命名規範：

1.         使用Pascal命名類和方法。枚舉類型以複數結尾。

public class CreditCard
{
  public string GetCardName()
}

2.         使用Camel來命名局部變數和方法參數。其名字應該與底層資料類型無關，而且應該反映該變數所代表的事物。

int cardCount;
public string GetCardName(string cardType)
{ }

3.         介面前加前輟 I。

interface IService{}  

4.         私人成員變數加前輟m_. 名字的其他部分使用Pascal命名方法。

public class CreditCard
{
    private string m_CardName;
}

5.         自訂屬性加後輟Attribute。
6.         自訂異常加後輟Exception。

7.         方法以動賓短語命名。例如ShowDialog( )

8.         有傳回值的方法名中應該有傳回值的描述。

9.         使用有意義的變數名。

l         不要使用單個字元作為變數名

l         不要使用匈牙利命名public 或者 protected 成員

l         不要縮寫單詞

10.     使用有意義的命名空間，如產品名，公司名。