Net-命名規(guī)范.doc

目目 錄錄 一、基礎編程規(guī)范一、基礎編程規(guī)范.3 1.命名原則.3 1.1大小寫原則.3 1.2命名規(guī)范.3 1.3類的命名原則.3 1.4接口命名原則.4 1.5EXCEPTION命名原則.4 1.6參數(shù)的命名.4 1.7變量的命名.4 1.8方法命名原則.5 1.9屬性命名原則.5 1.10大小寫敏感.5 2.注釋.5 2.1注釋通用原則.5 2.2類和接口的注釋.6 2.3類成員變量的注釋.6 2.4方法的注釋.6 2.5程序中的注釋.7 3.其他通用規(guī)范.7 3.1關于修改歷史.7 3.2成對出現(xiàn)的關鍵字和”的使用.7 3.3規(guī)則縮進.7 3.4判斷和循環(huán)的注釋.7 3.5縮寫.7 3.6關于漢語拼音.8 3.7關于神秘的數(shù)字.8 一、一、基礎編程規(guī)范基礎編程規(guī)范 使用.net 進行開發(fā)的過程中遵循的基本規(guī)范。 1.命名原則命名原則 編碼中的命名規(guī)范和原則 1.1大小寫原則大小寫原則 目前存在不同的大小寫規(guī)范，下面列出的這些規(guī)范將在其后的章節(jié)反復引用。 Pascal Casing 每個單詞的第一個字母大寫，例如：BackColor Camel Casing 除了第一個單詞以外的每個單詞的第一個字母大寫，例如：backColor Upper case 如果縮寫字母的個數(shù)小于或等于 2，那么所有的縮寫字母都大寫。3 個以上的字母縮寫采用 Pascal Casing。例如：System.IO, System.Web.UI, System.CodeDom。 1.2命名規(guī)范命名規(guī)范 類型類型命名規(guī)范命名規(guī)范備注備注 ClassPascalCase Enum valuesPascalCase Enum typePascalCase EventsPascalCase Exception classPascalCase以 Exception 結尾 Final Static fieldPascalCase interfacePascalCase用大寫字母 I 開頭 MethodPascalCase NamespacePascalCase propertyPascalCase Public Instance FieldPascalCase很少使用, 用在 properties Protected Instances Fields camelCase很少使用, 用在 properties parametercamelCase 1.3類的命名原則類的命名原則 用用 pascal 命名規(guī)則命名規(guī)則 盡量謹慎的使用縮寫盡量謹慎的使用縮寫 盡量不要使用任何的前綴（例如盡量不要使用任何的前綴（例如 C,T） 不要用下劃線作類名不要用下劃線作類名 例如： Public class FileStream Public class Button Public class String 1.4接口命名原則接口命名原則 接口名字用名詞或者名詞短語，或形容詞來表述接口的行為。接口名字用名詞或者名詞短語，或形容詞來表述接口的行為。 例如：IComponent (描述性名詞)、ICustomAttributeProvider (名詞短語)、IPersistable (形容詞) 等。 用用 Pascal 命名規(guī)則命名規(guī)則 盡量謹慎地使用縮寫盡量謹慎地使用縮寫 不要用下劃線作類名不要用下劃線作類名 接口名稱前綴用字母接口名稱前綴用字母 I 有的時候, 必須用字母 I 作為類名前綴，而又不是一個接口。這是可以接受的，因為有的類名就是 I 開頭 的，例如： IdentityStore。這種情況和接口的區(qū)別在于其第二個字母是小寫的。 有的時候，定義完一個接口之后，也會定義一個類作為接口的標準實現(xiàn)。該類和該接口應該有類似的名字， 唯一的區(qū)別就是接口名稱前綴為字母 I。 下面的例子描述了接口 IComponent 和它的標準實現(xiàn)- 類 Component Public interface IComponent Public class Component ：IComponent 1.5Exception 命名原則命名原則 異常的命名以“Exception”為后綴，且繼承自平臺提供的異?；?PlatformBaseException，例如： Public class UserAlreadyExistsException : PlatformBaseException 1.6參數(shù)的命名參數(shù)的命名 參數(shù)的名字應該是描述性的參數(shù)的名字應該是描述性的 參數(shù)的名字應該具有自描述性，也就是說參數(shù)的名稱可以描述參數(shù)在大多數(shù)情況下的含義，參數(shù)的類型也 是可以從參數(shù)的名字推斷出來的。 參數(shù)的名字使用參數(shù)的名字使用 camel Casing（首字母小寫）（首字母小寫） 參數(shù)的名字是基于參數(shù)的含義而不是參數(shù)的類型參數(shù)的名字是基于參數(shù)的含義而不是參數(shù)的類型 不要使用保留參數(shù)（不要使用保留參數(shù)（Win32 API 常見）常見） 如果下一個版本需要更多的參數(shù)，那么加一個 overload 的方法。 參數(shù)的命名示例如下： Type GetType(string typeName) String Format(string format, object args) 1.7變量的命名變量的命名 避免無意義的變量命名，如下的命名應該避免： Contract a = new Contract(); 但以下情況除外，作為循環(huán)條件中的計數(shù)器： for ( int i = 0; i / 用戶姓名不合法時所拋出的異常 / 用戶登錄密碼不合法時所拋出的異常 User CreateUser(string loginName, string username, string password); 中填寫該方法的主要功能描述，中填寫該方法的注意事項，中填寫 方法的傳入?yún)?shù)，以及各參數(shù)的意義。 填寫函數(shù)返回值以及返回值的意義。注意在其中運用 xml 語法。 所有的 public 及 protected 方法都要注釋。.net2.0 下 public 若無注釋會報警告信息。 2.5程序中的注釋程序中的注釋 在程序中，采用 ”/”進行單行注釋。 所有程序中的分支語句需要注釋分支條件意義，循環(huán)語句需要注釋循環(huán)的起始條件和中止條件。 / 滿足支付條件 if (MeetPayCondition() / 循環(huán)遍歷數(shù)組 for ( int i = 0; i Array.Count; i+ ) 3.其他通用規(guī)范其他通用規(guī)范 3.1關于修改歷史關于修改歷史 在每一個程序單元（一個 C#文件或一個 VB.NET 文件）中記錄本程序單元的修改歷史，修改歷史包括日 期，修改者，修改動作。 / History: /2006-07-14 姜輝 創(chuàng)建 / 2006-10-9 張冠南 修改 根據(jù)同行評審結果進行修改 3.2成對出現(xiàn)的關鍵字和成對出現(xiàn)的關鍵字和”的使用的使用 相關聯(lián)的“和”要么處于同一行，要么處于同一列。 3.3規(guī)則縮進規(guī)則縮進 用”TAB”和空格處理縮進，相當于 4 個空格長度，用空格替代制表符。 3.4判斷和循環(huán)的注釋判斷和循環(huán)的注釋 對于大段的（超過 20 行）判斷、循環(huán)語句，要加注釋，對于判斷語句（如 if，switch），要說明判斷的 條件和程序的走向。對于循環(huán)語句（如 while,do while,for），要說明循環(huán)繼續(xù)和終止的條件。 3.5縮寫縮寫 一個項目中用到的同一詞語的縮寫要求完全統(tǒng)一，如”Project”縮寫為”PJT”，則不準用其它的縮寫，如” Prjt”或”Pjct”，并且區(qū)分大小寫，即”pjt”也不能再用于表示”Project”。 3.6關于漢語拼音關于漢語拼音 盡量不要使用漢語拼音的聲母縮寫來做命名。如”Py”用來表示”拼音”會有很多的歧義。 3.7關于神秘的數(shù)字關于神秘的數(shù)字 無論用何種語言編程，都不要出現(xiàn)神秘的數(shù)字，如下代碼應視為違反本規(guī)范： int n; n = 128; 對于程序中要用到的常數(shù)，在專門的文件中進行定義，定義方法統(tǒng)一用大寫的英文，例如： public final int FILE_NAME_MAX_LENTH = 128; 也可以寫入到獨立的配置文件中，在程序中讀出其中的數(shù)值。 如果僅僅是某個類中所使用的話，就作為常量寫入類中，例如： private const string SIGN_STATUS = “50”; 對于數(shù)據(jù)類型為 int 型的這些常量，盡量使用枚舉類型來處理這些神秘數(shù)字。 在程序中的數(shù)字也并不一定屬于神秘的數(shù)字，以下情況是允許的： 1，索引數(shù)字，比如數(shù)組訪問，數(shù)據(jù)庫字段讀取 dataReader.GetString(2); 2， 單元測試代碼中用到的數(shù)字。 控件控件 IdId 的命名采取的命名采取 camelcamel 大小寫，建議規(guī)則如下大小寫，建議規(guī)則如下： 控件類型名稱前綴樣例 TextBoxtxttxtDraftId DropDownListddlddlDraftStatus ButtonbtnbtnAuditProject MultiViewmvwmvwMultiPage ViewviwviwPageOne LinkButtonlbnlbnCreateDraftForm GridViewgvwgvwDeviceGridWiew LabellbllblCurrentPage MenumeumeuTab TreeViewtvwtvwOrganization CheckBoxcbxcbxCheck CheckBoxListcblcblChecks ImageButtonibnibnCreateDraftForm ImageimgimgPicture HyperLinkhlkhlkPageLink ListBoxlbxlbxPersons RadioButtonrbnrbnChoiceOne RadioButtonListrblrblChoices FileUploadfudfudChooseFile PanalpalpalEdit DataListdltdltEdit DetailsVie