自己總結的C#編碼規范--6.格式篇

 

• 格式

格式的統一使用可以使代碼清晰、美觀、方便閱讀。為了不影響編碼效率，在此只作如下規定：

• 長度

  1. 一個文件最好不要超過500行(除IDE自動生成的類)。
     1. 一個文件必須只有一個命名空間，嚴禁將多個命名空間放在一個文件里。
     2. 一個文件最好只有一個類。
     3. 如果超過500行，考慮拆分類或者使用Partial 類將類按照功能拆分。
  2. 一個方法的代碼最好不要超過50行，如果超過考慮將里面的邏輯封裝成函數。

• 空格、空行

空行的使用以使代碼清晰為為基本原則。空行影響程序的運行，但可以使代碼看起來清晰，增加可讀性，因此可以適當的使用。

1. 方法與方法之間有兩個空行
2. 函數內部變量聲明與函數內部邏輯之間有一個空行。
3. 函數內部一個邏輯完成后要有一個空行，然后再寫下一個邏輯

• 換行

換行掌握的原則是不要使一行代碼特別長，以方便讀者快速閱讀。

1. 請團隊所有成員開啟Visual Studio自動換行功能。

   Tools->Options->Text Editor->C#->Check the Word wrap CheckBox

   

2. 在不產生嚴重歧義或增加閱讀難度的情況下，盡量控制在80列以內，不能超過120列，以方便閱讀和代碼的打印。
3. 另外換行的原則是，在逗號后，操作符前換行，換行與首行要保持一個單位的縮進。
4. "{"和"}"必須單獨在一行上，且上下對齊。
5. If,while,do,try-catch-finaly 等語句后必須有{},即使里面只有一條語句或語句為空，且遵循"{"和"}"必須單獨在一行上上的規定。

    

• Region的使用

Region的使用可以明確代碼塊的范圍並提供相應注釋，因此提倡大家盡量使用。

同時Region也可以用來組織代碼結構，我們使用以下Region約定來使組織類：

1. 一個類應該用Region划分出Fields、Properties、Constructor、Private Methods和 Protected & Public Methods 五個區域。並按照上述順序從上到下排列。
2. 其中Fields、Properties、Constructor、Private Methods必須放在Region。而Protected & Public Methods 必須放在外面。Protected & Public Methods 是代碼閱讀者查找最頻繁的內容，這樣做可以方便代碼閱讀者使用Ctrl+M, O時能夠最快速度定位到自己想要查找的內容。

一個好的類結構第一層展開時應該如下圖所示：

• 使用VS的Format Document功能

一個類或者方法編寫完成后，必須使用Visual Studio 自帶的"Format Document"的功能進行排版后才能Check In.