.Net 項(xiàng)目代碼風(fēng)格要求小結(jié)

PDF版下載：項(xiàng)目代碼風(fēng)格要求V1.0.pdf

代碼風(fēng)格沒有正確與否，重要的是整齊劃一，這是我擬的一份《.Net 項(xiàng)目代碼風(fēng)格要求》，供大家參考。

1. C# 代碼風(fēng)格要求1.1注釋

類型、屬性、事件、方法、方法參數(shù)，根據(jù)需要添加注釋。

如果類型、屬性、事件、方法、方法參數(shù)的名稱已經(jīng)是自解釋了，不需要加注釋；否則需要添加注釋。

當(dāng)添加注釋時(shí)，添加方式如下圖所示：

1.2 類型（類、結(jié)構(gòu)、委托、接口）、字段、屬性、方法、事件的命名

優(yōu)先考慮英文，如果英文沒有合適的單詞描述，可以使用拼音，使用中文是不符合要求的。

唯一可以使用中文的地方是枚舉的枚舉項(xiàng)，枚舉項(xiàng)實(shí)際已經(jīng)不屬于本節(jié)標(biāo)題的范疇了。這里只是放到一起說明，如下圖所示：

1.3 不使用縮寫

所有類型、方法、參數(shù)、變量的命名不得使用縮寫，包括大家熟知的縮寫，例如msg。

1.4 代碼使用半展開

第一步，打開Visual Studio，進(jìn)入“工具”，“選項(xiàng)...”，如下圖所示：

第二步，進(jìn)入“文本編輯器”，“C#”，“格式設(shè)置”，“新行”，取消掉右側(cè)所有復(fù)選框中的對(duì)號(hào)，如下圖所示：

第三步，點(diǎn)擊“確定”，完成設(shè)置。

1.5 使用Tab作為縮進(jìn)，并設(shè)置縮進(jìn)大小為4

第一步，打開Visual Studio，進(jìn)入“工具”，“選項(xiàng)...”，如下圖所示：

第二步，進(jìn)入“文本編輯器”，“C#”，“制表符”，如下圖所示，設(shè)置制表符。

第三步，點(diǎn)擊“確定”，完成設(shè)置。

1.6 一個(gè).cs源文件至多定義兩個(gè)類型

如果兩個(gè)類型的關(guān)系是緊密相關(guān)的，比如 產(chǎn)品、產(chǎn)品類型，此時(shí)Product類，和ProductType枚舉可以定義在同一個(gè)Product.cs文件中。

但不能在一個(gè).cs文件中出現(xiàn)兩個(gè)不相關(guān)的類型定義，例如將 Product類和Reseller類（分銷商）定義在一個(gè)BasicInfo.cs文件中。

1.7 類型名稱和源文件名稱必須一致

當(dāng)類型命名為Product時(shí)，其源文件命名只能是Product.cs。

1.8 所有命名空間、類型名稱使用Pascal風(fēng)格（單詞首字母大寫）

如下圖所示，紅色標(biāo)記的為使用Pascal風(fēng)格的類型：

注意ProductType是私有類型，不管類型是公有的還是私有的，其命名總是采用Pascal風(fēng)格。

1.9 本地變量、方法參數(shù)名稱使用Camel風(fēng)格（首字母小寫，其后每個(gè)單詞的首字母大寫）

紅色標(biāo)記的為使用Camel風(fēng)格的變量或者方法參數(shù)：

1.10 私有方法、受保護(hù)方法，仍使用Pascal風(fēng)格命名

示例代碼如下：

1.11 如果if語句內(nèi)容只有一行，可以不加花括號(hào)，但是必須和if語句位于同一行

范例1.9 中的if判斷實(shí)際上與下面的語句是等效的：

1.12 調(diào)用類型內(nèi)部其他成員，需加this；調(diào)用父類成員，需加base

示例代碼如下：

1.13 類型內(nèi)部的私有和受保護(hù)字段，使用Camel風(fēng)格命名，但加“_”前綴

代碼示例如下：

1.14 不能出現(xiàn)公有字段

如果需要公有字段，使用屬性進(jìn)行包裝。

1.15 類型成員的排列順序

類型成員的排列順序自上而下依次為：

字段：私有字段、受保護(hù)字段

屬性：私有屬性、受保護(hù)屬性、公有屬性

事件：私有事件、受保護(hù)事件、公有事件

構(gòu)造函數(shù)：參數(shù)數(shù)量最多的構(gòu)造函數(shù)，參數(shù)數(shù)量中等的構(gòu)造函數(shù)，參數(shù)數(shù)量最少的構(gòu)造函數(shù)

方法：重載方法的排列順序與構(gòu)造函數(shù)相同，從參數(shù)數(shù)量最多往下至參數(shù)最少。

1.16 委托和事件的命名

委托以EventHandler作為后綴命名，例如 SalesOutEventHandler。

事件以其對(duì)應(yīng)的委托類型，去掉EventHandler后綴，并加上On前綴構(gòu)成。

例如，對(duì)于SalesOutEventHandler委托類型的事件，其事件名稱為：OnSalesOut。

示例代碼如下：

1.17 返回bool類型的方法、屬性的命名

如果方法返回的類型為bool類型，則其前綴為Is、Can或者 Try，例如：

1.18 常見集合類型后綴命名

凡符合下表所列的集合類型，應(yīng)添加相應(yīng)的后綴。