1. 程式人生 > >客戶端開發C#命名規範手冊

客戶端開發C#命名規範手冊

命名規範

  1. 使用駝峰法命名
  2. 類名使用首字母大寫的駝峰法命名,例如:PlayerObject
  3. 方法名使用首寫字母大寫命名方式,例如:Init()
  4. 成員變數、區域性變數都統一使用首字母小寫的命名方式,例如:localValue;屬性首字母大寫,欄位統一小寫;(屬性是指帶get,set訪問器的)
  5. 常量和enum的命名都使用大寫+下劃線的方式,例如:MAX_PLAYER_NUMBER
  6. 抽象類名使用Abstract開頭,例如:AbstractCharacter,介面使用I開頭,例如:ITask
  7. 避免在類和變數的命名中使用縮寫
  8. 對於介面和抽象類,需要在類前加註釋,在每個方法上也儘量多寫註釋,用來說明類或者函式的作用
  9. 列舉類名也使用首字母大寫的駝峰法命名,且以Enum結尾,例如:ServerStatusEnum
  10. 所有的語句塊必須使用大括號包裹,禁止出現if(condition) do();這種使用方式,這種寫法不利於除錯

駝峰式(補充)

駝峰式命名法就是當變數名或函式名是由一個或多個單詞連結在一起,而構成的唯一識別字時,第一個單詞以小寫字母開始;第二個單詞的首字母大寫或每一個單詞的首字母都採用大寫字母,例如:myFirstName、myLastName,這樣的變數名看上去就像駝峰峰一樣此起彼伏,故得名。
駝峰式命名法(Camel-Case)一詞來自 Perl 語言中普遍使用的大小寫混合格式,而 Larry Wall 等人所著的暢銷書《Programming Perl》(O’Reilly 出版)的封面圖片正是一匹駱駝。
駝峰式命名法的命名規則可視為一種慣例,並無絕對與強制,為的是增加識別和可讀性。
小駝峰法


變數一般用小駝峰法標識。駝峰法的意思是:除第一個單詞之外,其他單詞首字母大寫。譬如
int myStudentCount;
變數myStudentCount第一個單詞是全部小寫,後面的單詞首字母大寫。
大駝峰法*
相比小駝峰法,大駝峰法把第一個單詞的首字母也大寫了。常用於類名,函式名,屬性,名稱空間。譬如
public class DataBaseUser;