細說C#編程命名規(guī)范
匈牙利命名法
我最早接觸到的命名規(guī)范是匈牙利命名法,該方法出自微軟,基本上是一些在你的所有變量前建立一個前綴的規(guī)則。這個前綴會說明那個變量的類型。其好處在于,通過它們的前綴,你可以方便地知道兩個變量是否兼容。這種方法非常流行,在目前的C和C++開發(fā)中還被廣泛的使用。
匈牙利命名法的不足
匈牙利命名法的***的不足的地方就是繁瑣,隨著計算機的速度越來越快,IDE已擁有足夠的能力,可以開始實時探測變量的類型。因此,當你編程時,IDE能夠向你警告類型不兼容的情況(通常普遍使用微軟Word自動拼寫檢查中的紅色彎曲下劃線)。
匈牙利命名法過分強調類型,在泛型方法中就顯得格格不入。另外,很多時候我們關心的只是這個變量所代表的意義而不是它的類型。像C++0x的auto關鍵字(雖然這個關鍵字在C++98中就存在,但沒法用)和C#的var關鍵字也說明了這一點。在小函數(shù)或者Lambda表達式這種比較簡單的流程的時候,過長的匈牙利變量顯得也很不合適。
其實主要的還是程序員懶惰心理作怪,但正是這種懶惰推動了計算機行業(yè)的不斷發(fā)展。就連微軟也逐步減少了匈牙利命名法的使用,在其當家語言C#中主要使用的是帕斯卡命名法和駱駝命名法。下面就簡單的介紹一下常用的C#編程命名規(guī)范。
C#編程命名規(guī)范
具體如下:
1.用camel規(guī)則來命名局部變量和方法的參數(shù),用pascal規(guī)則來命名方法和類型。
- public class TextBox
- {
- public void DataBind()
- {
- }
- }
- string userName;
- public AddUser(string userId,byte[] password);
2接口的名稱加前綴 I.
- interface ICompare
- {
- int Compare();
- }
3.自定義的屬性以Attribute結尾
- public class AuthorAttribute : Attribute
- {
- }
4.自定義的異常以Exception結尾
- public class AppException : Exception
- {
- }
5.方法的命名。一般將其命名為動賓短語。
- ShowDialog()
- CreateFile()
- GetPath()
6.代碼的縮進。要用Tab,而不要用space.
7.局部變量的名稱要有意義。不要用x,y,z等等(除用于For循環(huán)變量中可使用i,j,k,l,m,n)。
8.所有的成員變量聲明在類的頂端,用一個換行把它和方法分開。
9.用有意義的名字命名namespace,如:產品名、公司名。
10.生成和構建一個長的字符串時,一定要使用StringBuilder,而不用string.
11.始終使用"{ }"包含if下的語句,即使只有一條語句。
12.把相似的內容放在一起,比如數(shù)據成員、屬性、方法、事件等,并適當?shù)氖褂?region…#endregion,需要記住的一點是:編程規(guī)范的目的是幫助程序員寫出簡潔規(guī)范易讀的程序,但也沒必要過分被其所約束。
關于C#編程命名規(guī)范的內容就講到這里,希望大家喜歡。
【編輯推薦】