C#編程規(guī)范(2008年4月新版)
1 代碼格式
1.1 代碼縮進使用“保留制表符”，而不是“插入空格”，設(shè)置方式如下圖：
1.2 在代碼中垂直對齊左大括號和右大括號。
{
Response.Write("用戶編號必須輸入！");
}
不允許以下情況：
Response.Write("用戶編號必須輸入！");
}
或者：
1.3 為了防止在閱讀代碼時滾動源代碼編輯器，每行代碼或注釋在1024*800的顯示頻率下不得超過一顯示屏。
1.4 當一行被分為幾行時，通過將串聯(lián)運算符放在每一行的末尾而不是開頭，清楚地表示沒有后面的行是不完整的。
1.5 每一行上放置的語句不得超過一條。
1.6 在大多數(shù)運算符之前和之后使用空格，這樣做時不會改變代碼的意圖卻可以使代碼容易閱讀。
例：
而不應(yīng)寫為
1.7 將大的復雜代碼節(jié)分為較小的、易于理解的模塊。
1.8 編寫 SQL 語句時，對于關(guān)鍵字使用首字母大寫，對于數(shù)據(jù)庫元素（如表、列和視圖）使用大小寫混合。
1.9 將每個主要的 SQL 子句放在不同的行上，這樣更容易閱讀和編輯語句，例如：
FROM Customers
WHERE State = 'WA'
2 注釋（Comment）規(guī)范
注釋規(guī)范包括：模塊（類）注釋規(guī)范、類的屬性、方法注釋規(guī)范、代碼間注釋。
2.1 模塊（類）注釋規(guī)范
模塊開始必須以以下形式書寫模塊注釋：
///模塊編號：<模塊編號，可以引用系統(tǒng)設(shè)計中的模塊編號>
///作用：<對此類的描述，可以引用系統(tǒng)設(shè)計中的描述>
///作者：作者中文名
///編寫日期：<模塊創(chuàng)建日期，格式：YYYY-MM-DD>
///
如果模塊有修改，則每次修改必須添加以下注釋：
///
///Log編號：<LOG< SPAN>編號,從1開始一次增加>
///修改描述：<對此修改的描述>
///作者：修改者中文名
///修改日期：<模塊修改日期，格式：YYYY-MM-DD>
///
2.2 類屬性注釋規(guī)范
對類的屬性必須以以下格式編寫屬性注釋：
///屬性說明
///
2.3 方法注釋規(guī)范
在類的方法聲明前必須以以下格式編寫注釋
/// 此處為說明的內(nèi)容
/// </summary>
/// <param name="trans"></param> 參數(shù)說明
/// <param name="cmdType"></param>
/// <param name="cmdText"></param>
/// <param name="cmdParms"></param>
/// <returns></returns> 返回值說明
2.4 代碼間注釋規(guī)范
代碼間注釋分為單行注釋和多行注釋：
單行注釋：
多行注釋：
多行注釋2
多行注釋3*/
代碼中遇到語句塊時必須添加注釋（if,for,foreach,……）,添加的注釋必須能夠說明此語句塊的作用和實現(xiàn)手段（所用算法等等）。
3 變量（Variable）命名規(guī)范
3.1 程序文件（*.cs）中的變量命名規(guī)范
程序中變量名稱 = 變量的前綴 +代表變量含意的英文單詞或單詞縮寫。
1.類模塊級的變量請用“m_”作前綴
{
private string m_Name;
private DateTime m_Date;
}
2 類的屬性所對應(yīng)的變量，采用屬性名前加“m_”前綴的形式
{
private string m_Name;
public string Name
{
get
{
return m_Name;
}
}
}
3 過程級的變量不使用前綴
{
void say()
{
string SayWord;
}
}
4 過程的參數(shù)使用“p_”作為參數(shù)
{
void say(string p_SayWord)
{
}
}
補充說明：
針對異常捕獲過程中的Exception變量命名，在沒有沖突的情況下，統(tǒng)一命名為e；
如果有沖突的情況下，可以重復e，比如：ee。
{
//your code
try
{
//code
}
catch(Exception ee)
{
//your code
}
}
catch(Exception e)
{
//your code
}
補充：如果捕獲異常不需要作任何處理，則不需要定義Exception實例
例：
{
//your code
}
catch( Exception )
{
}
5 鑒于大多數(shù)名稱都是通過連接若干單詞構(gòu)造的，請使用大小寫混合的格式以簡化它們的閱讀。每個單詞的第一個字母都是大寫.
6 即使對于可能僅出現(xiàn)在幾個代碼行中的生存期很短的變量，仍然使用有意義的名稱。僅對于短循環(huán)索引使用單字母變量名，如 i 或 j。
7 在變量名中使用互補對，如 min/max、begin/end 和 open/close。
8 不要使用原義數(shù)字或原義字符串，如 For i = 1 To 7。而是使用命名常數(shù)，如 For i = 1 To NUM_DAYS_IN_WEEK 以便于維護和理解。
3.2 控件命名規(guī)則
控件命名 = Web控件縮寫前綴 + “_” +變量名
控件 縮寫
Label lbl
TextBox txt
CheckBox chk
Button cmd
ListBox lst
DropDownList drp
等等
4 常量命名規(guī)范
常量名也應(yīng)當有一定的意義，格式為 NOUN 或 NOUN_VERB。常量名均為大寫，字之間用下劃線分隔。
例：
private const int WEB_PAGECACHEEXPIRESINSECONDS_DEFAULT = 3600;
private const bool WEB_ENABLESSL_DEFAULT = false;
注：
變量名和常量名最多可以包含 255 個字符，但是，超過 25 到 30 個字符的名稱比較笨拙。此外，要想取一個有實際意義的名稱，清楚地表達變量或常量的用途，25 或 30 個字符應(yīng)當足夠了。
5 類（Class）命名規(guī)范
5.1 名字應(yīng)該能夠標識事物的特性。
5.2 名字盡量不使用縮寫，除非它是眾所周知的。
5.3 名字可以有兩個或三個單詞組成，但通常不應(yīng)多于三個。
5.4 在名字中，所有單詞第一個字母大寫。
例如 IsSuperUser，包含ID的，ID全部大寫，如CustomerID。
5.5 使用名詞或名詞短語命名類。
5.6 少用縮寫。
5.7 不要使用下劃線字符 (_)。
例：
public class Button
public class String
6 接口（Interface）命名規(guī)范
和類命名規(guī)范相同，唯一區(qū)別是 接口在名字前加上“I”前綴
例：
interface IButton;
7 方法（Method）命名規(guī)范
和類命名規(guī)范相同。
8 命名空間（NameSpace）命名規(guī)范
和類命名規(guī)范相同
9 文件名命名規(guī)范
和類命名規(guī)范相同
如對本文有疑問，請?zhí)峤坏浇涣髡搲?，廣大熱心網(wǎng)友會為你解答！！ 點擊進入論壇
