《C團(tuán)隊(duì)開發(fā)——代碼規(guī)范》由會員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫。

1、C#編程規(guī)范目錄1前言21.1編寫目的21.2范圍22.規(guī)范內(nèi)容22.1代碼格式22.2命名指南32.2.1大寫樣式32.2.2區(qū)分大小寫42.2.3縮寫52.2.4措詞52.2.5避免類型名稱混淆72.2.6命名空間命名指南82.2.7類命名指南92.2.8類成員變量命名指南102.2.9接口命名指南102.2.10屬性命名指南102.2.11枚舉類型命名指南112.2.12靜態(tài)字段命名指南112.2.13參數(shù)命名指南112.2.14方法命名指南122.2.15屬性命名指南122.2.16事件命名指南132

2、.3???注釋（Comment）規(guī)范142.3.1模塊（類）注釋規(guī)范142.3.2類屬性注釋規(guī)范152.3.3方法注釋規(guī)范152.3.4代碼間注釋規(guī)范153成功的模式163.1有效地使用這些標(biāo)準(zhǔn)163.2其它導(dǎo)向成功代碼的因素171前言1.1編寫目的為了保證團(tuán)隊(duì)編寫出的程序都符合相同的規(guī)范，保證一致性、統(tǒng)一性而建立的程序編碼規(guī)范。1.2范圍適用于所有基于.NET平臺的軟件開發(fā)工作。2.規(guī)范內(nèi)容2.1代碼格式u所有的縮進(jìn)為4個空格，使用VS.NET的默認(rèn)設(shè)置。u在代碼中垂直對齊左括號和右括號。if(x==0){

3、Response.Write("用戶編號必須輸入！");}不允許以下情況：if(x==0){Response.Write("用戶編號必須輸入！");}或者：if(x==0){Response.Write("用戶編號必須輸入！");}?u為了防止在閱讀代碼時不得不滾動源代碼編輯器，每行代碼或注釋在1024*800的顯示頻率下不得超過一顯示屏u當(dāng)一行被分為幾行時，通過將串聯(lián)運(yùn)算符放在每一行的末尾而不是開頭，清楚地表示沒有后面的行是不完整的。u每一行上放置的語句避免超過一條。u在大多數(shù)運(yùn)算符之前和之后使用空格，這樣

4、做時不會改變代碼的意圖卻可以使代碼容易閱讀。例：intj=i+k;而不應(yīng)寫為intj=i+k;u將大的復(fù)雜代碼節(jié)分為較小的、易于理解的模塊。2.2命名指南2.2.1大寫樣式使用下面的三種大寫標(biāo)識符約定。Pascal大小寫將標(biāo)識符的首字母和后面連接的每個單詞的首字母都大寫?？梢詫θ址蚋嘧址臉?biāo)識符使用Pascal大小寫。例如：BackColorCamel大小寫標(biāo)識符的首字母小寫，而每個后面連接的單詞的首字母都大寫。例如：backColor大寫標(biāo)識符中的所有字母都大寫。僅對于由兩個或者更少字母組成的標(biāo)識符使

5、用該約定。例如：System.IOSystem.Web.UI可能還必須大寫標(biāo)識符以維持與現(xiàn)有非托管符號方案的兼容性，在該方案中所有大寫字母經(jīng)常用于枚舉和常數(shù)值。一般情況下，在使用它們的程序集之外這些字符應(yīng)當(dāng)是不可見的。下表匯總了大寫規(guī)則，并提供了不同類型的標(biāo)識符的示例。標(biāo)識符大小寫示例類PascalAppDomain枚舉類型PascalErrorLevel枚舉值PascalFatalError事件PascalValueChange異常類PascalWebException注意總是以Exception后綴結(jié)尾。

6、只讀的靜態(tài)字段PascalRedValue接口PascalIDisposable注意總是以I前綴開始。方法PascalToString命名空間PascalSystem.Drawing參數(shù)CameltypeName屬性PascalBackColor受保護(hù)的實(shí)例字段CamelredValue注意很少使用。屬性優(yōu)于使用受保護(hù)的實(shí)例字段。公共實(shí)例字段PascalRedValue注意很少使用。屬性優(yōu)于使用公共實(shí)例字段。2.2.2區(qū)分大小寫為了避免混淆和保證跨語言交互操作，請遵循有關(guān)區(qū)分大小寫的使用的下列規(guī)則：u不要使用

7、要求區(qū)分大小寫的名稱。對于區(qū)分大小寫和不區(qū)分大小寫的語言，組件都必須完全可以使用。不區(qū)分大小寫的語言無法區(qū)分同一上下文中僅大小寫不同的兩個名稱。因此，在創(chuàng)建的組件或類中必須避免這種情況。u不要創(chuàng)建僅是名稱大小寫有區(qū)別的兩個命名空間。例如，不區(qū)分大小寫的語言無法區(qū)分以下兩個命名空間聲明。namespaceee.cummings;namespaceEe.Cummings;u不要創(chuàng)建具有僅是大小寫有區(qū)別的參數(shù)名稱的函數(shù)。下面的示例是不正確的。voidMyFunction(stringa,stringA)u不要創(chuàng)建具

8、有僅是大小寫有區(qū)別的類型名稱的命名空間。在下面的示例中，Pointp和POINTp是不適當(dāng)?shù)念愋兔Q，原因是它們僅是大小寫有區(qū)別。System.Windows.Forms.PointpSystem.Windows.Forms.POINTpu不要創(chuàng)建具有僅是大小寫有區(qū)別的屬性名稱的類型。在下面的示例中，intColor和intCOLOR是不適當(dāng)?shù)膶傩悦Q，原因是它們僅是大小寫有區(qū)別。intColor{