Net_命名規(guī)范

1、目錄一、基礎(chǔ)編程規(guī)范21. 命名原則2.1.1 大小寫原則2.1.2 命名規(guī)范2.1.3 類的命名原則2.1.4 接口命名原則3.1.5 exception命名原貝U3.1.6 參數(shù)的命名3.1.7 變量的命名3.1.8 方法命名原則4.1.9 屬性命名原則4.1.10 大小寫敏感4.2. 注釋4.2.1 注釋通用原則4.2.2 類和接口的注釋5.2.3 類成員變量的注釋5.2.4 方法的注釋5.2.5 程序中的注釋6.3. 其他通用規(guī)范6.3.1 關(guān)于修改歷史6.3.2 成對出現(xiàn)的關(guān)鍵字和"。的使用.6.3.3 規(guī)則縮進6.3.4 判斷和循環(huán)的注釋6.3.5 縮寫6.3.6 關(guān)于漢

2、語拼音7.3.7 關(guān)于神秘的數(shù)字7.一、基礎(chǔ)編程規(guī)范使用.net進行開發(fā)的過程中遵循的基本規(guī)范。1 .命名原則編碼中的命名規(guī)范和原則1.1 大小寫原則目前存在不同的大小寫規(guī)范，下面列出的這些規(guī)范將在其后的章節(jié)反復(fù)引用。PascalCasing每個單詞的第一個字母大寫，例如：BackColorCamelCasing除了第一個單詞以外的每個單詞的第一個字母大寫，例如：backColorUppercase如果縮寫字母的個數(shù)小于或等于2,那么所有的縮寫字母都大寫。3個以上的字母縮寫采用PascalCasing例如：System.。System.Web.UI,System.CodeDom。1.2命名規(guī)范

3、命名規(guī)范備注ClassPascalCaseEnumvaluesPascalCaseEnumtypePascalCaseEventsPascalCaseExceptionclassPascalCase以Exception結(jié)尾FinalStaticfieldPascalCaseinterfacePascalCase用大寫字母I開頭MethodPascalCaseNamespacePascalCasepropertyPascalCasePublicInstanceFieldPascalCase很少使用，用在propertiesProtectedInstancesFieldscamelCase很少使用

4、，用在propertiesparametercamelCase1.3類的命名原則用pascal命名規(guī)則盡量謹慎的使用縮寫盡量不要使用任何的前綴（例如C,T）不要用下劃線作類名例如：PublicclassFileStreamPublicclassButtonPublicclassString1.4 接口命名原則接口名字用名詞或者名詞短語，或形容詞來表述接口的行為。例如：IComponent（描述性名詞）、ICustomAttributeProvider（名詞短語）、IPersistable（形容詞）用Pascal命名規(guī)則盡量謹慎地使用縮寫不要用下劃線作類名接口名稱前綴用字母I有的時候，必須用字母

5、I作為類名前綴，而又不是一個接口。這是可以接受的，因為有的類名就是I開頭的,例如：IdentityStore。這種情況和接口的區(qū)別在于其第二個字母是小寫的。有的時候，定義完一個接口之后，也會定義一個類作為接口的標(biāo)準(zhǔn)實現(xiàn)。該類和該接口應(yīng)該有類似的名字，唯一的區(qū)別就是接口名稱前綴為字母I。下面的例子描述了接口IComponent和它的標(biāo)準(zhǔn)實現(xiàn)-類ComponentPublicinterfaceIComponentPublicclassComponent:IComponent1.5 Exception命名原則異常的命名以“Exception”為后綴，且繼承自平臺提供的異?；怭latformBase

6、Exception,例如:PublicclassUserAlreadyExistsException:PlatformBaseExceptionJ1.6 參數(shù)的命名參數(shù)的名字應(yīng)該是描述性的參數(shù)的名字應(yīng)該具有自描述性，也就是說參數(shù)的名稱可以描述參數(shù)在大多數(shù)情況下的含義，參數(shù)的類型也是可以從參數(shù)的名字推斷出來的。參數(shù)的名字使用camelCasing（首字母小寫）參數(shù)的名字是基于參數(shù)的含義而不是參數(shù)的類型不要使用保留參數(shù)（Win32API常見）如果下一個版本需要更多的參數(shù)，那么加一個overload的方法。參數(shù)的命名示例如下：TypeGetType（stringtypeName）StringForm

7、at（stringformat,object口args）1.7 變量的命名避免無意義的變量命名，如下的命名應(yīng)該避免：Contracta=newContract。；但以下情況除外，作為循環(huán)條件中的計數(shù)器：for（inti=0;i<MaxNum;i+）1.8 方法命名原則用動詞或動詞短語來命名用Pascal命名約定方法的命名示例如下：RemoveAll()Char口GetCharArray()1.9 屬性命名原則屬性名稱使用名詞或名詞短語用Pascal命名約定可以考慮用類型名稱作為屬性名稱屬性的命名示例如下：PublicColorColorGetSet1.10 大小寫敏感不要出現(xiàn)必須要大小寫

8、敏感支持的名字.組件，應(yīng)該在無論大小寫敏感或不敏感的語言中都能使用。因為需要大小寫敏感的語言不能識別兩個相同內(nèi)容但用大小寫區(qū)分的名字，所以組件必須避免這種情況不要出現(xiàn)兩個只用大小寫區(qū)分的命名空間，如namespaceee.cummings;namespaceEe.Cummings;不要出現(xiàn)兩個只用大小寫區(qū)分的參數(shù)如.voidfoo(stringa,stringA)不要出現(xiàn)只用大小寫區(qū)分的同一命名空間的類型System.WinForms.Pointp;System.WinForms.POINTpp;不要出現(xiàn)只用大小寫區(qū)分的同一類型屬性。intFooget,set;intFOOget,set不要出

9、現(xiàn)兩個只用大小寫區(qū)分的方法voidfoo();voidFoo();2 .注釋2.1 注釋通用原則原則上平均每100行代碼中要有2030行注釋，視程序復(fù)雜程度而定。所有注釋應(yīng)使用中文。對于源文件和類，必須在注釋中說明修改歷史。2.2 類和接口的注釋采用微軟.Net提供的格式，具體內(nèi)容如下：/<summary>/<seecref="IUserManager"/>接口定義了<seecref="User"/>實體類的增、刪、改、讀/（CRUD方法，該接口的實現(xiàn)類將負責(zé)用戶對象的簡單管理。/</summary>/&l

10、t;remarks>/<seecref="IUserManager"/>接口僅定義<seecref="User"/>實體對象的CRU操作方法，/并沒有定義關(guān)聯(lián)用戶對象與群組、組織機構(gòu)等的操作，這些業(yè)務(wù)邏輯操作的方法定義在/專門的關(guān)聯(lián)操作接口<seecref="IUserGroupAssociator"/>及<seecref="IUserOrgAssociator"/>1/</remarks>/Title:lUserManager/Copyright:

11、*SoftwareLTD.coCopyright（c）2006/Company:*有限公司/Designer:*/Coder:姜輝/Reviewer:/Tester:*/Version:1.0/History:/2006-07-14姜輝創(chuàng)建/2006-07-15姜輝編碼/2006-08-10姜輝修改根據(jù)外部用戶需要，包裝GetUserNameById（）WEB服務(wù)方法.在<summary>中填寫類的簡要描述，<remarks>中填寫類的一些注意事項。Histroy填寫修改記錄。所有類和接口都要注釋。類的操作注釋由詳細設(shè)計產(chǎn)物導(dǎo)出，編程人員補充完成從Title到Histo

12、ry的部分。2.3 類成員變量的注釋類成員變量的注釋如下例所示：/<summary>/用戶的名稱/</summary>privatestringusername;在聲明前，利用.Net的格式來注釋，原則上類的成員變量都要注釋。2.4 方法的注釋方法的注釋如下例所示：/<summary>/根據(jù)指定向用戶登錄名、姓名及密碼創(chuàng)建（注冊）一個新用戶（<seecref="User"/>）。/</summary>/<remarks>/當(dāng)滿足如下任意情形之一時，創(chuàng)建用戶的操作將會失?。?1,指定的用戶名在用戶持久化存

13、儲中已存在/2,指定的用戶名不合法（空值，空字符串，多個空格，包含除字母及數(shù)字以外的非法字符，長度/超過64）/3,指定的用戶密碼不合法（空值，空字符串，多個空格，包含除字母及數(shù)字以外的非法字符，長/度小于6位或大于位64）/4,指定的用戶姓名不合法（空值，空字符串，多個空格，長度大于位64）/</remarks>/<paramname="loginName”>用戶的登錄名，該屬性必須唯一，如"zhangsan“</param>/<paramname="username">用戶的名稱，該屬性可以重復(fù)，如多個

14、用戶均可以叫"張三”</param>III<paramname="password">用戶登錄的密碼</param>/<returns>創(chuàng)建的新用戶對象(<seecref="User"I>)<Ireturns>IIIexceptioncref="UserAlreadyExistsException”>用戶已經(jīng)存在時所拋出的異常<Iexception>IIIexceptioncref="InvalidLoginNameException”

15、>用戶登錄名不合法時所拋出的異常Iexception>IIIexceptioncref="InvalidUsernameException">用戶姓名不合法時所拋出的異常<Iexception>IIIexceptioncref="InvalidPasswordException”>用戶登錄密碼不合法時所拋出的異常exceptionUserCreateUser(stringloginName,stringusername,stringpassword);summary>中填寫該方法的主要功能描述，remarks>中填寫

16、該方法的注意事項，param>中填寫方法的傳入?yún)?shù)，以及各參數(shù)的意義。returns>填寫函數(shù)返回值以及返回值的意義。注意在其中運用xml語法。所有的public及protected方法都要注釋。.net2.0下public若無注釋會報警告信息。2.5程序中的注釋在程序中，采用“II”進行單行注釋。所有程序中的分支語句需要注釋分支條件意義，循環(huán)語句需要注釋循環(huán)的起始條件和中止條件。II滿足支付條件if(MeetPayCondition()II循環(huán)遍歷數(shù)組for(inti=0;iArray.Count;i+)3.其他通用規(guī)范3.1關(guān)于修改歷史在每一個程序單元（一個C#文件或一個VB.

17、NET文件）中記錄本程序單元的修改歷史，修改歷史包括日期，修改者，修改動作。IIIHistory:III2006-07-14姜輝創(chuàng)建III2006-10-9張冠南修改根據(jù)同行評審結(jié)果進行修改3.2 成對出現(xiàn)的關(guān)鍵字和”的使用相關(guān)聯(lián)的和"”要么處于同一行，要么處于同一列。3.3 規(guī)則縮進用“TAB”和空格處理縮進，相當(dāng)于4個空格長度，用空格替代制表符。3.4 判斷和循環(huán)的注釋對于大段的（超過20行）判斷、循環(huán)語句，要加注釋，對于判斷語句（如if,switch）,要說明判斷的條件和程序的走向。對于循環(huán)語句（如while,dowhile,for）,要說明循環(huán)繼續(xù)和終止的條件。3.5 縮寫一

18、個項目中用到的同一詞語的縮寫要求完全統(tǒng)一，如"Project”縮寫為“PJ'，則不準(zhǔn)用其它的縮寫，如"Prjt或“Pjct”，并且區(qū)分大小寫，即“pjt”也不能再用于表示"Project3.6 關(guān)于漢語拼音盡量不要使用漢語拼音的聲母縮寫來做命名。如“Py”用來表示“拼音”會有很多的歧義。3.7 關(guān)于神秘的數(shù)字無論用何種語言編程，都不要出現(xiàn)神秘的數(shù)字，如下代碼應(yīng)視為違反本規(guī)范：intn;n=128;對于程序中要用到的常數(shù)，在專門的文件中進行定義，定義方法統(tǒng)一用大寫的英文，例如:publicfinalintFILE_NAME_MAX_LENTH=128;也可以

19、寫入到獨立的配置文件中，在程序中讀出其中的數(shù)值。如果僅僅是某個類中所使用的話，就作為常量寫入類中，例如：privateconststringSIGN_STATUS=50”;對于數(shù)據(jù)類型為int型的這些常量，盡量使用枚舉類型來處理這些神秘數(shù)字。在程序中的數(shù)字也并不一定屬于神秘的數(shù)字，以下情況是允許的：1,索引數(shù)字，比如數(shù)組訪問，數(shù)據(jù)庫字段讀取dataReader.GetString(2);2,單元測試代碼中用到的數(shù)字?？丶蘒d的命名采取camel大小寫，建議規(guī)則如下：控件類型名稱前綴樣例TextBoxtxttxtDraftIdDropDownListddlddlDraftStatusButtonbtnbtnAuditProjec