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

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