[C#]C# Coding 規則

C# Coding 規則

標示符命名規則

標示符是指變數,類別或是結構,和類別與結構的成員的變數名稱。

  1. 必須以字母或底線開頭。
  2. 不能將關鍵字作為標示符用,如果需要,則須在標示符號前,加上前綴字符@
  3. 標示符也可以包含 Unicode。

命名規則

一般對於變數或是類別方法名稱的宣告,或將該宣告的變數,以有意圖的方式來命名。(單字組合) 一般命名的規則可分為兩類,一個是 Pascal ,另外一個則是 Camel。

  1. Pascal : 大小寫形式,每個單字開頭皆為大寫,一般 Pascal 大都使用在非參數的宣告,即類別名稱、方法,屬性等。 例如 :
class Person。
ToDoSomething()。
public int Age {get;set;}。
  1. Camel : 開頭的單字為小寫,而後整個單字組開頭皆為大寫,一般用在傳遞參數或是宣告變數上使用。有時候,有些人的宣告的變數前面會加上底線。
  • 一般都是私有成員使用 Camel
  • 傳遞給方法的所有名稱都應該是以 Camel 形式
  • 透過 Camel 也可以使用大小寫來區分兩個不同的對象。

例如:

private string name;
private string firstName;
private string lastName;
private string _name;
...
class Person {
    private int _name;
    public Person(string name) {
        this._name = name;
    }
}

...
private int _age;

public int Age {
    get {return _age;}
    set { _age = value;}
}

命名風格

命名的風格名稱最好要一致。例如 : ShowConfig(),EditConfig()。

命名空間的名稱

MS 有建議命名空間的法則,即

< CompanyName >.< TechnologyName > 

命名名稱和關鍵字

兩者不應該互相衝突。

留言

這個網誌中的熱門文章

[Tools] GCOV & LCOV 初探

Quilt Patch 管理操作方法