【分享】代碼命名與代碼備註規範

代碼命名與備註規範

1. 命名規則

駝峯式命名法（Camel）：用於給普通變量（局部變量）的命名，第一個單詞的首字母小寫，其他的單詞首字母大寫。如myAge、myName。

帕斯卡命名法（Pascal）：用於給類、方法（函數）和屬性（屬性的本質是get和set兩個函數）命名的規範，每一個單詞的首字母大寫。如HighSchoolStudent。

　　

　　2.函數或方法

　　命名規範：Pascal（每一個單詞的首字母大寫）

　　備註規範：

1. [Summary] 需描述清楚該函數或方法的執行什麼
2. [param] 每一個參數都必須描述清楚參數意義，在多值的狀況下要一一備註清楚
3. [renturn] 描述返回結果，如遇不一樣的返回值表明特定意義需描述清楚，例如若返回 1表明***

　　如下給出的C#的備註案例，其餘語言大同小異　　　　

 

　　如下是js代碼範例

　　

　　

　　3.屬性

 　　　　命名規範：公共屬性採用Pascal命名方式

　　　　私有屬性採用Camel命名方式，並如下劃線「_」開頭，如 「_userName」

　　　　備註規範：

　　　　[summary] 描述清楚該屬性的意義，如遇不一樣的值表明特定意義需描述清楚，例如 1表明*** 2表明***

　　　　範例：

1 ///<summary>
2 /// 用戶類型 1=設計師 2=企業6=設計公司 7=設計工做室
3 ///</summary>
4 
5 public short UserType { get; set; }

 

 　　4. 變量 

　　　　命名規範：採用Camel命名方式

　　　　備註規範：只要定義變量就必須備註，在變量定義後面描述清楚該變量的意義，如遇不一樣的值表明特   定意義需描述清楚，例如1表明*** 2表明***

　　　　範例：

 　　　　 float step = 1;//認證步驟 營業執照認證=1 法人認證=2 管理受權=3 

 

　　5.代碼段

　　if else / switch case / for等代碼段 要描述清楚接下來的代碼段的執行意義

　　C#應更可能的使用region對代碼段進行區塊化

　　如下範例視爲合格 

 　　

 

　　

 

 

 　　

　　6.其餘命名規範

　　　　(1)接口類以Interface的縮寫 I 開頭

　　　　(2)事件不要以event結尾，class不要以class結尾

　　　　(3)禁止使用縮寫,除URL、IO等能達成共識的縮寫除外，使用縮寫可全大寫

　　　　(4)在對任何東西命名時須要使用有意義的名稱，而且保證單詞拼寫正確以及語法正確，避免使用拼音(地名等    通用拼音除外),避免使用關鍵字