C#編碼通訊協定

標籤：

一、命名規範

1.PascalCasting

PascalCasing 每一個單詞第一個字母大寫，其餘字母均小寫。例如：FileAccess,ArraySegment等。

• 除了參數、變數、常量外，所有命名空間名稱、類、 函數、介面、屬性、事件、枚舉等名稱的命名，使用Pascal風格。

2.camelCasting

camelCasing 第一個單詞首字母小寫，其餘單字首大寫。例如：propertyName,filePath等。

• 參數與變數的命名使用camelCasing風格。

3.SCREAMING_CAPS

SCREAMING_CAPS每個單詞的所有字母都大寫，單詞與單詞之間用"_"串連，該風格目前在c#中只用於const常量。

如：public const string DEFAULT_PAGE = "default.aspx";

• 只用於const常量。

4.私人變數的命名

Private的私人變數使用底線""或"m"+camelCasing的大小寫規則，以便快速確認該變數的範圍。

如: private int _userId;

二、命名方法

1.所有的命名（包括標識符，類，介面，函數等等）使用有意義的英文標識符，不允許使用漢語拼音，也不允許使用中文作為各種命名。

2.避免容易被主觀解釋的難懂的名稱，如方面名 AnalyzeThis()，或者屬性名稱 xxK8。這樣的名稱會導致多義性。

3、在類屬性的名稱中包含類名是多餘的，如 Book.BookTitle。而是應該使用 Book.Title。

4、只要合適，在變數名的末尾或開頭加計算限定符（Avg、Sum、Min、Max、Index）。

5、在變數名中使用互補對，如 min/max、begin/end 和 open/close。

6、布爾變數名表示是否時可以包含 Is，這意味著 Yes/No 或 True/False 值，如 fileIsFound。

7、即使對於可能僅出現在幾個程式碼中的生存期很短的變數，仍然使用有意義的名稱。僅對於短迴圈索引使用單字母變數名，如 i 或 j。

三、附錄

1、控制項相關命名,紅色是常用控制項

控制項名	簡寫	控制項名	簡寫
Label	lbl	TextBox	txt
Button	btn	LinkButton	lnkbtn
ImageButton	imgbtn	DropDownList	ddl
ListBox	lst	DataGridView	dgv
DataList	dl	CheckBox	chk
CheckBoxList	chkls	RadioButton	rdo
RadioButtonList	rdolt	Image	img
Panel	pnl	Calender	cld
AdRotator	ar	Table	tbl
RequiredFieldValidator	rfv	CompareValidator	cv
RangeValidator	rv	RegularExpressionValidator	rev
ValidatorSummary	vs	CrystalReportViewer	rptvew
ListView	lst	DataGrid	dg

2 常見集合類型尾碼命名

凡符合下表所列的集合類型，應添加相應的尾碼。

說明	尾碼	樣本
數組	Array 或 s	int[] productArray 或 int[] products
列表	List 或 s	List<Product> productList 或 List<Product> products
DataTable/HashTable	Table	HashTable productTable
字典	Dictionary 或 Dic	Dictionay<string,string> productDictionary 或 Dictionay<string,string> productDic
DbSet /DataSet	Set 或DataSet	DbSet<Product> productSet 或 DbSet<Product> productDataSet
集合	Coll 或 s 或 Collection	TableCollection tables 或 TableCollection tableColl 或 TableCollection tableCollection

3、常見尾碼命名

凡符合下表所列的局部變數、方法參數、欄位、屬性，均需添加相應的尾碼。

尾碼	樣本	樣本說明
費用相關	Cost	ShipCost	運輸費
價格相關	Price	ProductUnitPrice	產品單價
訊息相關	Message	SuccessMessage	成功訊息
日期相關	Date	OrderDate	下單日期
計數、數量相關	Count	LoginCount	登入次數
連結地址相關	Url	BlogUrl	部落格連結
圖片相關	Image	SignImage	簽名圖片
金額相關	Amount	PrepaidAmount	預付款
點數、積分相關	Point	MemberPoint	會員積分
記錄相關	Record	ErrorRecord	錯誤記錄
配置相關	Config	DataBaseConfig	資料庫配置
狀態相關	Status	OrderStatus	訂單狀態
模式、方式相關	Mode	OpenMode	開啟檔案
種類相關	Category / Type(類型) / Class 三選一	UserCategory	使用者種類
工廠類相關	Factory	ConnectionFactory	串連工廠
啟用相關	Enabled	ExportEnabled	開啟匯出
流相關	Stream	UploadStream	上傳流
讀取器相關	Reader	ExcelReader	Excel讀取器
寫入器相關	Writer	ExcelWriter	Excel寫入器
適配器相關	Adapter	IntroOPAdapter	IntroOP適配器
提供器相關	Provider	MemebershipProvider	會員資訊提供器
封裝器相關	Wrapper	ProductWrapper	Product封裝器
串連相關	Connection	ExcelConnection	Excel串連

 4、常見類型命名

凡存在下表中的類型，需採用下表指定的名稱命名。

命名	類型	命名
客戶	Customer	分銷商	Reseller
零售商	Retailer	經銷商/批發商	Dealer
使用者	user	訂單	Order
供應商	Supplier	管理員	Admin
密碼	Password	會員	Member
評論	Remark	文章	Article
新聞	News	發票	Invoice
匯入	Import	匯出	Export
公司、企業	Company	產品	Product
省份	Province	城市	City
區縣	District	地址	Address
角色	Role	許可權	Authority
倉庫	Warehouse	工廠	Plant
登入	Login	登出	LogOut
建立	Create	編輯	Edit
更新	Update	刪除	Remove
照片	Photo	圖片	Image

5、 常見欄位，屬性命名

欄位、屬性種類比較繁雜，因此僅列出最常用的幾項。

名稱	類型	名稱
Id（int型）	Id（“d”小寫，棄用ID）	GuidId（Guid型）	Id
Name	名稱	Title	標題
Remark	備忘、描述（棄用Memo、Description）	Category	種類（棄用Class、Type）

C#編碼通訊協定