一、代碼格式

在編寫代碼的過程中，代碼格式方面建議遵守一下規則。
（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。

轉載于:https://www.cnblogs.com/jRoger/articles/1833536.html

總結

以上是生活随笔為你收集整理的c#编码规范【转载】的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。