c#編碼規範【轉載】

weixin_34162629發表於2010-09-23

一、程式碼格式

在編寫程式碼的過程中,程式碼格式方面建議遵守一下規則。
(1)通常情況下,程式碼縮排為4個空格,這是Visual Studio 2005的預設設定。
(2)在程式碼中垂直對齊同一層次的左括號和右括號。
(3)為了防止在閱讀程式碼時左右滾動原始碼編輯器,每行程式碼或註釋不得超過一個螢幕。
(4)當一行被分為幾行時,需要將串聯運算子放在每一行的末尾。
(5)每一行上放置的語句避免超過一條。
(6)在大多數運算子之前和之後使用空格,這樣做是不會改變程式碼意圖的,卻可以使程式碼更加容易閱讀。
(7)將大的複雜程式碼節分為較小的、易於理解的模組。
(8)編寫SQL語句時,關鍵字全部使用大寫,資料庫元素(如表、列和檢視)使用大小寫混合。
(9)將每個主要的SQL子句放在不同的行上,這樣更容易閱讀和編輯語句。
  示例程式碼如下:
  SELECT FirstName,LastName
  FROM Customers
  WHERE State = ‘CHN’

二、註釋規範

註釋規範包括:原始檔註釋規範、類註釋規範、類的屬性和方法註釋規範、程式碼間註釋。

1。原始檔註釋規範
建議的原始檔頭部註釋示例如下所示。
/*****************************************************
** 文 件 名:
** Copyright (c) 2005-2006 ********軟體專案開發部門
** 檔案編號:
** 創 建 人:
** 日 期:
** 修 改 人:
** 日 期:
** 描 述:
********************************************************/

2。類註釋規範
類開始部分必須以如下形式書寫註釋。
/**********************************************************
** 類 編 號:<類編號可以引用系統設計中的類編號>
** 作 用:<對此類的描述,可以引用系統設計中的描述>
** 作 者:作者中文名
** 編寫日期:<類建立口期,格式:YYYY-MM-DD>
**********************************************************/

3。類屬性註釋規範

在類的屬性前必須以如下格式編寫屬性註釋。
//
//屬性說明
//

4、方法註釋規範

在類的方法宣告前必須以如下格式編寫註釋。
/*****************************************************
** 函 數 名:
** 功能描述:
** 輸入引數:a - 型別 <說明>
** b - 型別 <說明>
** 輸出引數:x - 型別 <說明>
** 返 回 值:- 型別 <說明>
** 作 者:作者中文名
** 日 期:
** 修 改 人:<修改人>
** 日 期:
********************************************************/

5。程式碼間註釋規範

程式碼間註釋應遵從以下規範。
//
//<註釋>
//
程式碼中遇到語句塊時,例如,if,for,foreach必須新增註釋。新增的註釋要能夠說明此語句塊的作用和實現手段。

三、類命名規範

(1)名字應該能夠標識事物的特性。
(2)名字儘量不使用縮寫,除非是眾所周知的。
(3)名字可以由兩個或三個單片語成,通常不應多於三個。
(4)在名字中,所有單詞第一個字母大寫。
(5)使用名詞或名詞短語命名類。
(6)少用縮寫。
(7)不要使用下劃線字元(_)。

四、介面命名規範

和類命名規範相同,唯一區別是介面在名字前加上“I”字首。

五、方法命名規範

和類命名規範相同。

六、名字空間命名規範

和類命名規範相同。

七、程式版本號確定規範

主程式的版本號由主版本號十次版本號+Build(Fix版本號)構成。主版本號表示程式的重大修改,例如,修改或改進了程式的重要功能。次版本號表示程式的一般修改,例如,修改或了程式的一般功能。Fix議版本號表示程式Bug的修改,以修改的日期縮寫表示,如2006-8-20修改的Fix版本號就是20060820。舉例說明,程式版本號為1.2bulid(2060820),表示該程式的主號是1,次版本號為2,Fix版本號為20060820。

相關文章