Net-命名規(guī)范

1、.Net編程規(guī)范V1.0第10頁共7頁1.1.2、基礎(chǔ)編程規(guī)范命名原則.大小寫原則.命名規(guī)范.接口命名原則EXCEPTION命名原則 參數(shù)的命名變量的命名方法命名原則屬性命名原則.類成員變量的注釋 方法的注釋 程序中的注釋 其他通用規(guī)范 關(guān)于修改歷史 成對(duì)出現(xiàn)的關(guān)鍵字和” 的使用 規(guī)則縮進(jìn) 判斷和循環(huán)的注釋 縮寫 關(guān)于漢語拼音555555563.7基礎(chǔ)編程規(guī)范使用.net進(jìn)行開發(fā)的過程中遵循的基本規(guī)范。1.命名原則編碼中的命名規(guī)范和原則大小寫原則目前存在不同的大小寫規(guī)范，下面列出的這些規(guī)范

2、將在其后的章節(jié)反復(fù)引用。Pascal Casing每個(gè)單詞的第一個(gè)字母大寫，例如：BackColorCamel CasingbackColor除了第一個(gè)單詞以外的每個(gè)單詞的第一個(gè)字母大寫，例如:Upper case如果縮寫字母的個(gè)數(shù)小于或等于2，那么所有的縮寫字母都大寫。3個(gè)以上的字母縮寫采用Pascal Casing 。例如：System.IO, System.Web.UI, System.CodeDom。1.2 命名規(guī)范類型命名規(guī)范備注ClassPascalCaseEnum valuesPascalCaseEnum typePascalCaseEventsPascalCaseExce pt

3、i on classPascalCase以Exception結(jié)尾Fi nal Static fieldPascalCasein terfacePascalCase用大寫字母1開頭MethodPascalCaseNames pacePascalCasepropertyPascalCaseP ublic In sta nee FieldPascalCase很少使用，用在propertiesProtected In sta nces FieldscamelCase很少使用，用在propertiesp arametercamelCase1.3 類的命名原則用Pascal命名規(guī)則盡量謹(jǐn)慎的使用縮寫盡量不

4、要使用任何的前綴（例如C,T ）不要用下劃線作類名例如:Public classPublic class Butt onPublic class String1.4接口命名原則接口名字用名詞或者名詞短語，或形容詞來表述接口的行為。名詞短語）、IPersistable （ 形容詞）例如：IComponent (描述性名詞)、ICustomAttributeProvider (等。用Pascal命名規(guī)則 盡量謹(jǐn)慎地使用縮寫 不要用下劃線作類名 接口名稱前綴用字母I有的時(shí)候，必須用字母I作為類名前綴，而又不是一個(gè)接口。這是可以接受的，因?yàn)橛械念惷褪荌開頭的, 例如：Ide ntityStore。這

5、種情況和接口的區(qū)別在于其第二個(gè)字母是小寫的。有的時(shí)候，定義完一個(gè)接口之后，也會(huì)定義一個(gè)類作為接口的標(biāo)準(zhǔn)實(shí)現(xiàn)。該類和該接口應(yīng)該有類似的名字, 唯一的區(qū)別就是接口名稱前綴為字母I。F面的例子描述了接口IComponent和它的標(biāo)準(zhǔn)實(shí)現(xiàn)-類ComponentPublic in terface ICo mponent:IComponentPublic class Component1.5 Excep tion 命名原則異常的命名以"Exception ”為后綴，且繼承自平臺(tái)提供的異?；怭latformBaseException，例如:P ublic class UserAlreadyExi

6、stsExce pti on : P latformBaseExce pti on 1.6 參數(shù)的命名參數(shù)的名字應(yīng)該是描述性的參數(shù)的名字應(yīng)該具有自描述性，也就是說參數(shù)的名稱可以描述參數(shù)在大多數(shù)情況下的含義，參數(shù)的類型也 是可以從參數(shù)的名字推斷出來的。參數(shù)的名字使用 camel Cas ing（首字母小寫）參數(shù)的名字是基于參數(shù)的含義而不是參數(shù)的類型不要使用保留參數(shù)（Win 32 API 常見）如果下一個(gè)版本需要更多的參數(shù)，那么加一個(gè)overload 的方法。參數(shù)的命名示例如下:Type GetT yp e(stri ng typ eName) String Format(stn ng forma

7、t, object args)1.7變量的命名避免無意義的變量命名，如下的命名應(yīng)該避免: Con tract a = new Con tract（）;但以下情況除外，作為循環(huán)條件中的計(jì)數(shù)器： for （ int i = 0; i < MaxNum; i+）1.8 方法命名原則用動(dòng)詞或動(dòng)詞短語來命名 用Pascal命名約定方法的命名示例如下:RemoveAll()Char GetCharArrayO1.9 屬性命名原則屬性名稱使用名詞或名詞短語用Pascal命名約定 可以考慮用類型名稱作為屬性名稱屬性的命名示例如下:Public Color Color GetSet1.10 大小寫敏感因?yàn)?/p>

8、需不要出現(xiàn)必須要大小寫敏感支持的名字 .組件，應(yīng)該在無論大小寫敏感或不敏感的語言中都能使用。 要大小寫敏感的語言不能識(shí)別兩個(gè)相同內(nèi)容但用大小寫區(qū)分的名字，所以組件必須避免這種情況不要出現(xiàn)兩個(gè)只用大小寫區(qū)分的命名空間，如n ames pace ee.cum min gs; n ames pace Ee.Cummi ngs;不要出現(xiàn)兩個(gè)只用大小寫區(qū)分的參數(shù)如void foo(stn ng a, stri ng A)不要出現(xiàn)只用大小寫區(qū)分的同一命名空間的類型System.Wi nForms.Point p;System.Wi nForms .P OINT pp;不要出現(xiàn)只用大小寫區(qū)分的同一類型屬性。

9、int Foo get, set; int FOO get, set不要出現(xiàn)兩個(gè)只用大小寫區(qū)分的方法void foo(); void Foo();2.注釋2.1注釋通用原則原則上平均每100行代碼中要有2030行注釋，視程序復(fù)雜程度而定。所有注釋應(yīng)使用中文。對(duì)于源文件和類，必須在注釋中說明修改歷史。2.2類和接口的注釋采用微軟.Net提供的格式，具體內(nèi)容如下:/ / / / / / / / / / / / / / / / / / / / /<summary><see cref="IUserManager"/> 接口定義了 <see cref=&

10、quot;User"/>(CRUD方法，該接口的實(shí)現(xiàn)類將負(fù)責(zé)用戶對(duì)象的簡(jiǎn)單管理。</summary><remarks><see cref="IUserManager"/> 接口僅定義 <see cref="User"/>實(shí)體類的增、刪、改、讀實(shí)體對(duì)象的CRU操作方法,并沒有定義關(guān)聯(lián)用戶對(duì)象與群組、組織機(jī)構(gòu)等的操作，這些業(yè)務(wù)邏輯操作的方法定義在專門的關(guān)聯(lián)操作接口 <see cref="IUserGrou pAssociator"/及 <see cref=&quo

11、t;IUserOrgAssociator"/></remarks>Title: IUserMa nagerCo pyright: *Company: *Desig ner: *Coder: 姜輝Reviewer:Tester: *Versio n: 1.0History:2006-07-142006-07-152006-08-10Software LTD.co Cop yright (c) 2006有限公司姜輝創(chuàng)建姜輝編碼姜輝修改根據(jù)外部用戶需要，包裝GetUserNameByld（）WEB服務(wù)方法.在<summary>中填寫類的簡(jiǎn)要描述，<rem

12、arks>中填寫類的一些注意事項(xiàng)。Histroy 填寫修改記錄。2.32.4中。所有類和接口都要注釋。類的操作注釋由詳細(xì)設(shè)計(jì)產(chǎn)物導(dǎo)出，編程人員補(bǔ)充完成從 分。類成員變量的注釋類成員變量的注釋如下例所示:/<summary>用戶的名稱</summary>p rivatestri ng user name;在聲明前，利用.Net的格式來注釋，原則上類的成員變量都要注釋。方法的注釋方法的注釋如下例所示:/ / / / / / / / / / / / / / /<summary>根據(jù)指定的用戶登錄名、姓名及密碼創(chuàng)建（注冊(cè)）一個(gè)新用戶（</summary&

13、gt;<remarks>當(dāng)滿足如下任意情形之一時(shí)，創(chuàng)建用戶的操作將會(huì)失?。?，指定的用戶名在用戶持久化存儲(chǔ)中已存在2，Title 到History 的部<see cref="User"/>）。指定的用戶名不合法（空值，空字符串，多個(gè)空格，包含除字母及數(shù)字以外的非法字符， 超過64）指定的用戶密碼不合法（空值，空字符串，多個(gè)空格，包含除字母及數(shù)字以外的非法字符，長(zhǎng) 度小于6位或大于位64）長(zhǎng)度4，指定的用戶姓名不合法（空值，空字符串，多個(gè)空格，長(zhǎng)度大于位</remarks><param name="loginName&quo

14、t;>用戶的登錄名，該屬性必須唯一，如"<p aram name="username">用戶的名稱，該屬性可以重復(fù)，如多個(gè)用戶均可以叫"張三” vparam name="password"> 用戶登錄的密碼 </param>64)zhangsan ” </param></p aram>/<returns> 創(chuàng)建的新用戶對(duì)象(<see cref="User"/><exce ptio n cref="UserAlread

15、yExistsExce pti on"><exce pti on cref="I nvalidLogi nN ameExce pti on"><exce pti on cref="I nvalidUser nameExce pti on"><exce pti on cref="I nvalid PasswordExce pti on">）</returns>用戶已經(jīng)存在時(shí)所拋出的異常 用戶登錄名不合法時(shí)所拋出的異常 用戶姓名不合法時(shí)所拋出的異常用戶登錄密碼不合法時(shí)所拋出的

16、異常</exce pti on>/exce pti on></exce pti on><exce pti on>User CreateUser( stri ng log inN ame, stri ng user name, stri ng p assword);<summary>中填寫該方法的主要功能描述，<remarks>中填寫該方法的注意事項(xiàng)，<p aram> 中填寫方法的傳入?yún)?shù)，以及各參數(shù)的意義。 <returns>填寫函數(shù)返回值以及返回值的意義。注意在其中運(yùn)用xml 語法。所有的public及

17、protected方法都要注釋。.net2.0 下public若無注釋會(huì)報(bào)警告信息。2.5程序中的注釋在程序中，采用” ”進(jìn)行單行注釋。所有程序中的分支語句需要注釋分支條件意義，循環(huán)語句需要注釋循環(huán)的起始條件和中止條件。/滿足支付條件if (Meet PayCo nditio n()/循環(huán)遍歷數(shù)組for ( int i = 0; i < Array.Co unt; i+ )3.其他通用規(guī)范3.1關(guān)于修改歷史在每一個(gè)程序單元（一個(gè) 期，修改者，修改動(dòng)作。C#文件或一個(gè) VB.NET文件）中記錄本程序單元的修改歷史，修改歷史包括日/History:/2006-07-14姜輝創(chuàng)建/2006-1

18、0-9張冠南修改根據(jù)同行評(píng)審結(jié)果進(jìn)行修改3.2成對(duì)出現(xiàn)的關(guān)鍵字和 ” ”的使用相關(guān)聯(lián)的“和”要么處于同一行，要么處于同一列。3.3規(guī)則縮進(jìn)用”TAB ”和空格處理縮進(jìn)，相當(dāng)于 4個(gè)空格長(zhǎng)度，用空格替代制表符。3.4判斷和循環(huán)的注釋對(duì)于大段的（超過 20行）判斷、循環(huán)語句，要加注釋，對(duì)于判斷語句（如 if, switch ），要說明判斷的 條件和程序的走向。對(duì)于循環(huán)語句（如 while,do while,for ），要說明循環(huán)繼續(xù)和終止的條件。3.5縮寫一個(gè)項(xiàng)目中用到的同一詞語的縮寫要求完全統(tǒng)一，如”Project ”縮寫為”PJT”則不準(zhǔn)用其它的縮寫，女'Prjt ”或”Pjct”并且

19、區(qū)分大小寫，即”pjt ”也不能再用于表示”Project ”3.6 關(guān)于漢語拼音盡量不要使用漢語拼音的聲母縮寫來做命名。如”Py”用來表示”拼音”會(huì)有很多的歧義。3.7 關(guān)于神秘的數(shù)字無論用何種語言編程，都不要出現(xiàn)神秘的數(shù)字，如下代碼應(yīng)視為違反本規(guī)范:int n;n = 128;對(duì)于程序中要用到的常數(shù)，在專門的文件中進(jìn)行定義，定義方法統(tǒng)一用大寫的英文，例如:public final int = 128也可以寫入到獨(dú)立的配置文件中，在程序中讀出其中的數(shù)值。如果僅僅是某個(gè)類中所使用的話，就作為常量寫入類中，例如:private con st stri ng SIGN_STA TUS = 50”;對(duì)于數(shù)據(jù)類型為int型的這些常量，盡量使用枚舉類型來處理這些神秘?cái)?shù)字。在程序中的數(shù)字也并不一定屬于神秘的數(shù)字，以下情況是允許的:1，索引數(shù)字，比如數(shù)組訪問，數(shù)據(jù)庫字段讀取dataReader.GetString(2);2，單元測(cè)試代碼中用到的數(shù)字?？丶蘒d的命名采取camel大小寫，建議規(guī)則如下：控件類型名稱前綴樣例TextBoxtxttxtDraftIdDrop Dow nListddlddlDraftStatusButt onbtnbtn Audit Proje