C# 編碼規範簡明查詢手冊

C# 編碼規範簡明查詢手冊

 

命名術語說明

 

術語	說明
Pascal 大小寫	將標識符的首字母和後面連接的每個單詞的首字母都大寫。可以對三字符或更多字符的標識符使用 Pascal 大小寫。例如：BackColor
Camel 大小寫	標識符的首字母小寫，而每個後面連接的單詞的首字母都大寫。例如：backColor

 

代碼命名

 

標誌符	規 則	實例與描述
命名空間namespace	Pascal	Nd.ClassLibrary.Charting 命名空間就表示Nd公司裏的公用類庫裏的Charting畫圖類庫
類對象命名	obj+Pascal	如：Article objPascal = new Article ()
類class	Pascal	Article 使用完整的單詞，避免用縮寫 。一般使用具有名詞性質的名稱
局部變量	Camel	int type = 0; 不使用用以指明數據類型的匈牙利前綴表示法，如(strReturn)
只讀靜態變量	Pascal	static readonly string ConnString = “”;
數據成員 （類私有變量）	_ + Pascal	以_開頭＋Pascal命名規則，如_ProductType 。（考慮到私有變量特殊性，這裏將特殊使用_前綴）
屬性	Pascal	BackColor 。屬性名稱通常都是名詞。例如Text 。
接口interface	Pascal	IDisposable 注：總是以 I 前綴開始，後接Pascal命名
方法function	Pascal	方法名通常是動詞。方法實現一個對象的行爲功能。有返回值的方法必須在方法命名裏包含對該返回值的信息描述。如：GetArticleDataset ()。
枚舉類型enum	Pascal	EQFormatConditionOperator，枚舉值也是Pascal， 比如EQFormatConditionOperator. Equal
委託delegate	Pascal	AfterOperationHandler，總是以Handler爲後綴結尾
常量const	全大寫	SYSTEM_DEFAULT_INT注：字母全部大寫，單詞間用_下劃線隔開
參數	Camel	如：GetArticleDataset (Article objArticle，int userId)

 

 

 

 

 

頁面控件命名

 

類 型	前 綴	示 例
AdRotator	adrt	adrtTopAd
Button	btn	btnSubmit
Calendar	cal	calMettingDates
CheckBox	chk	chkBlue
CheckBoxList	chkl	chklFavColors
CompareValidator	valc	valcValidAge
CustomValidator	valx	valxDBCheck
DataGrid	dgrd	dgrdTitles
DataList	dlst	dlstTitles
DropDownList	drop	dropCountries
HyperLink	lnk	lnkDetails
Image	img	imgAuntBetty
ImageButton	ibtn	ibtnSubmit
Label	lbl	lblResults
LinkButton	lbtn	lbtnSubmit
ListBox	lst	lstCountries
Panel	pnl	pnlForm2
PlaceHolder	plh	plhFormContents
RadioButton	rad	radFemale
RadioButtonList	radl	radlGender
RangeValidator	valg	valgAge
RegularExpression	vale	valeEmail_Validator
Repeater	rpt	rptQueryResults
RequiredFieldValidator	valr	valrFirstName
Table	tbl	tblCountryCodes
TableCell	tblc	tblcGermany
TableRow	tblr	tblrCountry
TextBox	txt	txtFirstName
ValidationSummary	vals	valsFormErrors
XML	xmlc	xmlcTransformResults

 

 

 

ADO.NET 常用命名

 

類 型	前 綴	示 例
Connection	con	conNorthwind
Command	cmd	cmdReturnProducts
Parameter	parm	parmProductID
DataAdapter	dad	dadProducts
DataReader	dtr	dtrProducts
DataSet	dst	dstNorthWind
DataTable	dtbl	dtblProduct
DataRow	drow	drowRow98
DataColumn	dcol	dcolProductID
DataRelation	drel	drelMasterDetail
DataView	dvw	dvwFilteredProducts

名稱空間寫法，各名稱空間插入空行

using System;

using System.Text;

using System.Collections;

using System.Web.UI;

using System.Web.UI.WebControls;

using System.Web.UI.HtmlControls;

 

using Microsoft.Web.UI.WebControls;      

 

using net91com.Movies.DataAccess;

using net91com.Movies.Business;

using net91com.CommonComponent;

 

 

 

#region 代碼塊

 

#region 描述不加特殊字符，只加關鍵性描述。