程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> .NET網頁編程 >> C# >> C#入門知識 >> C#.NET編碼規范整理

C#.NET編碼規范整理

編輯:C#入門知識

一、  環境設置 

首先去除VS開發環境中的一些選項如下:

粘貼時調整縮進

將類型的左大括號置於新行

將方法的左大括號置於新行

將匿名方法的左大括號置於新行

將控制塊的左大括號置於新行

將“else”置於新行

將“catch”置於新行

將“finally”置於新行

復選框去掉.

 

二、  命名規范

1)        通用性

l   標識的總長度不要超過32個字符。

l     標識符的基本語法是以字母和_開始,由字母數字及下劃線組成的單詞,第一個字符不能是數字。

l     只要合適,在變量名的末尾追加計算限定符(Avg、Sum、Min、Max、Index)。

l     在變量名中使用互補對,如 min/max、begin/end 和 open/close。

l     布爾變量名應該前加或包含 Is(is)。

l   盡量減少使用縮寫,而是使用以一致方式創建的縮寫。縮寫應該只有一個意思;同樣,每個縮寫詞也應該只有一個縮寫。例如,如果用 min 作為 minimum 的縮寫,那麼在所有地方都應這樣做;不要將 min 又用作 minute 的縮寫。

l   在命名函數時包括返回值的說明,如 GetCurrentWindowName()。

l   避免對不同的元素重用名稱,如名為 ProcessSales() 的例程和名為 iProcessSales 的變量。

l   在命名元素時避免同音異義詞(如 write 和 right),以防在檢查代碼時發生混淆。

l   在命名元素時,避免使用普遍拼錯的詞。另外,應清楚區域拼寫之間存在的差異,如 color/colour 和 check/cheque。

l   在內部范圍中避免使用與外部范圍中的名稱相同的名稱。若訪問錯誤變量,則會產生錯誤結果。若變量與同一名稱的關鍵字沖突,則必須在關鍵字前加適當的類型庫以作標識。例如,若有一個名為 date 的變量,只能通過調用 System.Date 來使用內部 Date 函數。

l   接口名稱以前綴“I”開始,後面接一個名詞或名詞詞組(如 IComponent),或者接一個描述接口行為的形容詞(如 IPersistable)。不要使用下劃線,不要過多使用縮寫,因為縮寫會引起混淆。

l   事件處理程序的名稱以一個描述事件類型的名詞開始,後面接後綴“EventHandler”,如“MouseEventHandler”。 事件參數類的名稱裡要加“EventArgs”後綴。

l   如果某事件含有“之前”或“之後”的概念,請以現在時或過去時形式使用前綴,如“ControlAdd”或“ControlAdded”。

l   單個長字符串拆分成多行寫。當一行被分為幾行時,需要將串聯運算符放在每一行的末尾。

l   SQL Server中不要給存儲過程加sp 前綴/不要給用戶定義的函數加 fn_ 前綴/不要給擴展存儲過程加 xp_ 前綴。這些前綴是為標識系統保留的。將每個主要的SQL子句放在不同的行上,這樣更容易閱讀和編輯語句。

l   不要使用原義數字或原義字符串,如 For i = 1 To 7。而是使用命名常數,如 For i = 1 To NUM_DAYS_IN_WEEK 以便於維護和理解。

2)        變量命名

變量名稱命名規則:形容詞+名詞(或名詞)

  1. 屬性(類屬性/類屬性對應的私有變量)

l  類屬性與類屬性對應的私有變量基本一樣。

類屬性對應的私有變量是在類屬性名的前面加“_”

如:private int _PageSize;// 類屬性對應的私有變量

public int PageSize { set { _PageSize = value; } }//類屬性

l  注意大小寫要保持一致。每個單詞的第一個字母必須大寫。其它單詞的第一個字母也大寫。單詞之間不加“_”。

l  不要使用public來定義一個屬性。

l  屬性名和類名以名詞開始,如 EmployeeName 和 CarAccessory。

  1. 私有變量(短期性/長期性)

l  短期性(方法內私有變量/不是經常用的變量)

u  定義前加“_”

u  如:string _strSQL = null;

u  第一個單詞的第一個字母必須小寫,其它單詞第一個字母大寫。單詞之間不加“_”。

l  長期性(類私有變量/方法入口參數)

u  類私有變量:前加“_”,和類屬性對應的私有變量一樣。每個單詞的第一個字母必須大寫。其它單詞的第一個字母也大寫。單詞之間不加“_”。

如:private int _PageSizeTmp;

u  方法入口參數:第一個單詞的第一個字母必須小寫,其它單詞的第一個字母必須大寫。如果只有一個單詞組成全小寫。單詞之間不加“_”。

如:public static int SendCTTVOSMS(string mobile,string content)

public static string CallAccountHiVA(string restPhone,string userPhone)

  1. 全局變量/靜態變量/常量

l  定義要全部大寫。如:public static int SMS_TYPE = 2;

l  定義部分也可小寫。

如:public static string VOSMS_UserName = "88000002";

l  單詞與單詞之間加“_”分隔。

3)        函數命名

函數命名規則:動詞+名詞(或動詞),每個單詞第一個字母必須大寫。單詞之間不加“_”。

如:public static string GetOrderStatus(int sendMode,int statueID)

函數名和方法名以動詞開始,如 InitNameArray() 和 CloseDialog()。

4)        控件命名

控件命名規則:類別+名稱

類別對照表:

前綴

表示類型

frm

窗口

btn

按鈕

cbo

下拉式列表框

txt

文本輸入框

lbl

標簽

img

圖像

pic

圖片

div

DIV

grd

網格

scr

滾動條

lst

列表框

sds

SqlDataSource

ods

OleDbDataSource

如按鈕:btnSave

 

前綴

表示類型

b/is

Bool

c

Char

sb

Sbyte

b

Byte

n/i

Int

ui

Uint

l

Long

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved