程序員開發(fā)手冊

1、安全生產(chǎn)信息化管理系統(tǒng)程序員開發(fā)手冊安全生產(chǎn)信息化管理系統(tǒng)程序員開發(fā)手冊1概述1.1目的 1、方便代碼的交流和維護(hù)。 2、不影響編碼的效率，不與大眾習(xí)慣沖突。 3、使代碼更美觀、閱讀更方便。 4、使代碼的邏輯更清晰、更易于理解。1.2 范圍本手冊適用于開發(fā)部全體人員，作用于軟件項目開發(fā)的代碼編寫階段和后期維護(hù)階段。1.3警示通過自動檢查【Microsoft.StyleCop】或人工檢查【部門主管或相關(guān)負(fù)責(zé)人】不符合編碼規(guī)范的，必須在限期【部門主管或相關(guān)負(fù)責(zé)人指定時間】內(nèi)修正,逾期視為工作過失，部門主管或相關(guān)負(fù)責(zé)人視具體情況做出相關(guān)處理。1.4術(shù)語定義1、匈牙利命名法【禁用】標(biāo)識符的名字以一個或

2、者多個小寫字母開頭作為前綴；前綴之后的是首字母大寫的一個單詞或多個單詞組合，該單詞要指明變量的用途。例如：aUserId     數(shù)組 (Array)定義以小寫字母a開頭2、帕斯卡（pascal）命名法【推薦】將標(biāo)識符的首字母和后面連接的每個單詞的首字母都大寫?？梢詫θ址蚋嘧址臉?biāo)識符使用Pascal 大小寫。例如：UserId3、駱駝(Camel)命名法【推薦】標(biāo)識符的首字母小寫，而每個后面連接的單詞的首字母都大寫。例如： userId2代碼格式2.1列寬1、為了防止在閱讀代碼時不得不滾動源代碼編輯器，每行代碼或注釋在一般顯示頻率下不得

3、超過一顯示屏，代碼列寬控制在110字符左右。2、系統(tǒng)中部分代碼可以不遵循此原則。如：VIWFormItemDetail dv = (VIWFormItemDetail)MHelper.SQLCommand.query(sql, VIWFormItemDetail.TName, sqlParams);3、SQL語句拼接、字符串拼接、函數(shù)參數(shù)名過長、判斷語句過長的代碼要遵循以上原則。2.2換行1、當(dāng)表達(dá)式超出或即將超出規(guī)定的列寬，一行被分為幾行時，通過將串聯(lián)運(yùn)算符放在每一行的末尾而不是開頭，清楚地表示沒有后面的行是不完整的。String querySql = “ SELECT ProjectId”

4、+“,ProjectTitle ”+“FROM Project ”2、每一行上放置的語句避免超過一條。 3、當(dāng)表達(dá)式超出或即將超出規(guī)定的列寬，遵循以下規(guī)則進(jìn)行換行(1)在逗號前換行。 （2）在操作符前換行。（3）規(guī)則1優(yōu)先于規(guī)則2。例如： StringBuilder querySql = new StringBuilder(); querySql.Append("SELECT a.ProjectId AS PK "); querySql.Append(",a.ProjectTitle"); querySql.Append(",a.Project

5、DisplayCode"); querySql.Append(",a.IsbnCode AS ISBNCode"); querySql.Append("FROM Project a ");當(dāng)以上規(guī)則會導(dǎo)致代碼混亂的時候自己采取更靈活的換行規(guī)則。2.3縮進(jìn)縮進(jìn)應(yīng)該是每行一個Tab(4個空格)，不要在代碼中使用Tab字符。Visual Studio.Net設(shè)置：工具->選項->文本編輯器->C#->制表符->插入空格2.4空行空行是為了將邏輯上相關(guān)聯(lián)的代碼分塊，以便提高代碼的可閱讀性。在以下情況下使用兩個空行1、接口和

6、類的定義之間。2、枚舉和類的定義之間。3、類與類的定義之間。 在以下情況下使用一個空行1、方法與方法、屬性與屬性之間。2、方法中變量聲明與語句之間。3、方法與方法之間。4、方法中不同的邏輯塊之間。5、方法中的返回語句與其他的語句之間。6、屬性與方法、屬性與字段、方法與字段之間。7、注釋與它注釋的語句間不空行，但與其他的語句間空一行。2.5空格在以下情況中要使用到空格1、關(guān)鍵字和左括符 “(” 應(yīng)該用空格隔開。如 while (true) 注意;在方法名和左括符 “(” 之間不要使用空格，這樣有助于辨認(rèn)代碼中的方法調(diào)用與關(guān)鍵字。多個參數(shù)用逗號隔開，每個逗號后都應(yīng)加一個空格。2、除了 . 之外，所

7、有的二元操作符都應(yīng)用空格與它們的操作數(shù)隔開。一元操作符、+及-與操作 數(shù)間不需要空格。如a+=c+d;a = (a + b) / (c * d);while(d+ = s+)n+;PrintSize(“size is “+size+“n”);3、語句中的表達(dá)式之間用空格隔開。如for(expr1; expr2; expr3)4、以下寫法是不允許的：int j=i+k;2.6括號 - ()1、左括號“(”不要緊靠關(guān)鍵字，中間用一個空格隔開。2、左括號“(”與方法名之間不要添加任何空格。3、沒有必要的話不要在返回語句中使用()。如if (condition)Array.Remove(1)retur

8、n 1 2.7花括號 - 1、左花括號 “”放于關(guān)鍵字或方法名的下一行并與之對齊。如if (condition) public int Add(int x, int y) 2、 左花括號 “”要與相應(yīng)的右花括號 “”對齊。3、通常情況下左花括號 “”單獨(dú)成行，不與任何語句并列一行。4、 if、while、do語句后一定要使用，即使號中為空或只有一條語句。如if(somevalue =1)somevalue = 2;右花括號“”后建議加一個注釋以便于方便的找到與之相應(yīng)的 。如 while(1) if (valid) / if valid else / not valid / end foreve

9、r以下情況是不允許的：if(x=0) Response.Write("用戶編號必須輸入！");          或者： if(x=0) Response.Write("用戶編號必須輸入！");2.8 分解將大的復(fù)雜代碼節(jié)分為較小的、易于理解的模塊。2.9 SQL1、編寫 SQL 語句時，對于關(guān)鍵字或保留字使用全部大寫，對于數(shù)據(jù)庫元素（如表、列和視圖等命名）使用帕斯卡命名法命名。如：SELECT UserId AS EmId FROM UserS

10、ELECT UserId AS EmId FROM User AS emSELECT UserId AS EmId FROM User AS EM等允許使用；2、將每個主要的 SQL 子句放在不同的行上，這樣更容易閱讀和編輯語句。例如： SELECT FirstName, LastNameFROM CustomersWHERE State = 'WA'3、不要從數(shù)據(jù)表中調(diào)用頁面或程序不需要的字段；2.10 引用1、對于程序中字段名稱的引用要通過對應(yīng)的屬性調(diào)用實(shí)現(xiàn)。如：Int userId = (int)Dv0“UserId”; 是不允許的；Int userId = (int)D

11、v0User.x.UserId.ColumnName; 是允許的；string bookPriceName = Book.x.BookPrice.ColumnName;decimal? bookPrice = null;if(drbookPriceName != DBNull.Value) bookPrice = (decimal)drbookPriceName;是允許的；3 程序注釋3.1注釋概述1、修改代碼時，總是使代碼周圍的注釋保持最新。2、在每個例程的開始，提供標(biāo)準(zhǔn)的注釋樣本以指示例程的用途、假設(shè)和限制很有幫助。注釋樣本應(yīng)該是解釋它為什么存在和可以做什么的簡短介紹。3、避免在代碼行的末

12、尾添加注釋；行尾注釋使代碼更難閱讀。不過在批注變量聲明時，行尾注釋是合適的；在這種情況下，將所有行尾注釋在公共制表位處對齊。 4 、避免雜亂的注釋，如一整行星號。而是應(yīng)該使用空白將注釋同代碼分開。 5 、避免在塊注釋的周圍加上印刷框。這樣看起來可能很漂亮，但是難于維護(hù)。6 、在部署發(fā)布之前，移除所有臨時或無關(guān)的注釋，以避免在日后的維護(hù)工作中產(chǎn)生混亂。7 、如果需要用注釋來解釋復(fù)雜的代碼節(jié)，請檢查此代碼以確定是否應(yīng)該重寫它。盡一切可能不注釋難以理解的代碼，而應(yīng)該重寫它。盡管一般不應(yīng)該為了使代碼更簡單以便于人們使用而犧牲性能，但必須保持性能和可維護(hù)性之間的平衡。8 、在編寫注釋時使用完整的句子。注

13、釋應(yīng)該闡明代碼，而不應(yīng)該增加多義性。 9 、在編寫代碼時就注釋，因為以后很可能沒有時間這樣做。另外，如果有機(jī)會復(fù)查已編寫的代碼，在今天看來很明顯的東西六周以后或許就不明顯了。10 、避免多余的或不適當(dāng)?shù)淖⑨專缬哪牟恢饕膫渥ⅰ?1、 使用注釋來解釋代碼的意圖。它們不應(yīng)作為代碼的聯(lián)機(jī)翻譯。 12、 注釋代碼中不十分明顯的任何內(nèi)容。13 、為了防止問題反復(fù)出現(xiàn)，對錯誤修復(fù)和解決方法代碼總是使用注釋，尤其是在團(tuán)隊環(huán)境中。14 、對由循環(huán)和邏輯分支組成的代碼使用注釋。這些是幫助源代碼讀者的主要方面。 15 、在整個應(yīng)用程序中，使用具有一致的標(biāo)點(diǎn)和結(jié)構(gòu)的統(tǒng)一樣式來構(gòu)造注釋。 16 、用空白將注釋同注

14、釋分隔符分開。在沒有顏色提示的情況下查看注釋時，這樣做會使注釋很明顯且容易被找到。17 、在所有的代碼修改處加上修改內(nèi)容的注釋（此項只供參考）。18、對于常量、變量、表達(dá)式等使用單行注釋時建議放到聲明的后面；19、對于常量、變量、表達(dá)式等建議使用單行注釋，單行注釋格式如：private int number; / 注釋語句或：/注釋語句private int number; 20 、為了使層次清晰，在閉合的右花括號后注釋該閉合所對應(yīng)的起點(diǎn)（此項只供參考）。 namespace Langchao.Procument.Web / namespace Langchao.Procument.Web3.

15、2文檔型注釋 該類注釋采用.Net已定義好的Xml標(biāo)簽來標(biāo)記，在聲明接口、類、方法、屬性、字段都應(yīng)該使用該類注釋，以便代碼完成后直接生成代碼文檔，讓別人更好的了解代碼的實(shí)現(xiàn)和接口。如/<summary>MyMethod is a method in the MyClass class./<para>Here's how you could make a second paragraph in a description./<see cref="System.Console.WriteLine"/>/for information

16、about output statements./</para>/<seealso cref="MyClass.Main"/>/</summary> public static void MyMethod(int Int1) 又如：類屬性注釋規(guī)范在類的屬性必須以以下格式編寫屬性注釋：/ <summary>/屬性說明/ </summary>方法注釋規(guī)范在類的方法聲明前必須以以下格式編寫注釋/ <summary> / 說明：<對該方法的說明>/ </summary>/ &l

17、t;param name="<參數(shù)名稱>"><參數(shù)說明></param>/ <returns>/<對方法返回值的說明，該說明必須明確說明返回的值代表什么含義>/ </returns>3.3類c注釋（此項只供參考）該類注釋用于1、不再使用的代碼。2、臨時測試屏蔽某些代碼。用法/*修改標(biāo)識修改原因. . . (the source code )*/3.4單行注釋該類注釋用于1、方法內(nèi)的代碼注釋。如變量的聲明、代碼或代碼段的解釋。注釋示例：/ <summary>/ 注釋語句/ </su

18、mmary> private int number;或 /注釋語句 private int number;或 private int number;/ 注釋語句 2、方法內(nèi)變量的聲明或花括號后的注釋, 注釋示例： if ( 1 = 1) / always true statement; / always true3.5 文件注釋文件功能描述只需簡述，具體詳情在類的注釋中描述。3.6注釋標(biāo)簽標(biāo)簽用法作用<c>c>錯誤!超鏈接引用無效。</c>text 希望將其指示為代碼的文本。為您提供了一種將說明中的文本標(biāo)記為代碼的方法。使用 <code> 將多行

19、指示為代碼<para><para>錯誤!超鏈接引用無效。</para>content段落文本。用于諸如 <remarks> 或 <returns> 等標(biāo)記內(nèi)，使您得以將結(jié)構(gòu)添加到文本中。<param><param name='錯誤!超鏈接引用無效。'>錯誤!超鏈接引用無效。</param>name 為方法參數(shù)名。將此名稱用單引號括起來 (' ')。應(yīng)當(dāng)用于方法聲明的注釋中，以描述方法的一個參數(shù)。<paramref><paramref name=&qu

20、ot;錯誤!超鏈接引用無效。"/>name要引用的參數(shù)名。將此名稱用雙引號括起來 (" ")。<paramref> 標(biāo)記為您提供了一種指示詞為參數(shù)的方法。可以處理 XML 文件，從而用某種獨(dú)特的方法格式化該參數(shù)。<see><see 錯誤!超鏈接引用無效。錯誤!超鏈接引用無效。"member"/>cref = "member"對可以通過當(dāng)前編譯環(huán)境進(jìn)行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后，將 member 傳遞給輸出 XML 中的元素名。必須將 member 括在雙引

21、號 (" ") 中。使您得以從文本內(nèi)指定鏈接。使用 <seealso> 指示希望在“請參閱”一節(jié)中出現(xiàn)的文本。<seealso><seealso 錯誤!超鏈接引用無效。錯誤!超鏈接引用無效。"member"/>cref = "member"對可以通過當(dāng)前編譯環(huán)境進(jìn)行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后，將 member 傳遞給輸出 XML 中的元素名。必須將 member 括在雙引號 (" ") 中使您得以指定希望在“請參閱”一節(jié)中出現(xiàn)的文本。使用 <se

22、e> 從文本<example><example>錯誤!超鏈接引用無效。</example>description代碼示例的說明。使用 <example> 標(biāo)記可以指定使用方法或其他庫成員的示例。一般情況下，這將涉及到 <code> 標(biāo)記的使用。<code><code>錯誤!超鏈接引用無效。</code>content 為希望將其標(biāo)記為代碼的文本。記為您提供了一種將多行指示為代碼的方法。使用<c>指示應(yīng)將說明中的文本標(biāo)記為代碼<summary><summary>

23、;錯誤!超鏈接引用無效。</summary>此處description 為對象的摘要。應(yīng)當(dāng)用于描述類型成員。使用 <remarks> 以提供有關(guān)類型本身的信息。<exception><exception 錯誤!超鏈接引用無效。錯誤!超鏈接引用無效。"member">錯誤!超鏈接引用無效。</exception>cref = "member"對可從當(dāng)前編譯環(huán)境中獲取的異常的引用。編譯器檢查到給定異常存在后，將 member 轉(zhuǎn)換為輸出 XML 中的規(guī)范化元素名。必須將 member 括在雙引號 (

24、" ") 中。description 說明。<exception> 標(biāo)記使您可以指定類能夠引發(fā)的異常。<include><include file='錯誤!超鏈接引用無效。' path='錯誤!超鏈接引用無效。錯誤!超鏈接引用無效。="錯誤!超鏈接引用無效。"' />filename 包含文檔的文件名。該文件名可用路徑加以限定。將 filename 括在單引號中 (' ')。 Tagpath：filename 中指向標(biāo)記名的標(biāo)記路徑。將此路徑括在單引號中 (' &

25、#39;)。 name 注釋前邊的標(biāo)記中的名稱說明符；名稱具有一個 id。 id位于注釋之前的標(biāo)記的 id。將此 id 括在雙引號中 (" ")。<include> 標(biāo)記使您得以引用描述源代碼中類型和成員的另一文件中的注釋。這是除了將文檔注釋直接置于源代碼文件中之外的另一種可選方法。<include> 標(biāo)記使用 XML XPath 語法。有關(guān)自定義 <include> 使用的方法，請參閱 XPath 文檔。<list><list type="bullet" | "number" |

26、 "table"><listheader><term>錯誤!超鏈接引用無效。</term><description>錯誤!超鏈接引用無效。</description></listheader><item><term>錯誤!超鏈接引用無效。</term><description>錯誤!超鏈接引用無效。</description></item></list>term定義的項，該項將在 text 中定義。descript

27、ion目符號列表或編號列表中的項或者 term 的定義。<listheader> 塊用于定義表或定義列表中的標(biāo)題行。定義表時，只需為標(biāo)題中的項提供一個項。列表中的每一項用 <item> 塊指定。創(chuàng)建定義列表時，既需要指定 term 也需要指定 text。但是，對于表、項目符號列表或編號列表，只需為 text 提供一個項。列表或表所擁有的 <item> 塊數(shù)可以根據(jù)需要而定。<permission><permission 錯誤!超鏈接引用無效。錯誤!超鏈接引用無效。"member">錯誤!超鏈接引用無效。</p

28、ermission>cref = "member" 對可以通過當(dāng)前編譯環(huán)境進(jìn)行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后，將 member 轉(zhuǎn)換為輸出 XML 中的規(guī)范化元素名。必須將 member 括在雙引號 (" ") 中。 description成員的訪問的說明。<permission> 標(biāo)記使您得以將成員的訪問記入文檔。System.Security.PermissionSet 使您得以指定對成員的訪問。<remarks><remarks>錯誤!超鏈接引用無效。</remarks>

29、description 成員的說明。<remarks> 標(biāo)記是可以指定有關(guān)類或其他類型的概述信息的位置。<summary> 是可以描述該類型的成員的位置。<returns><returns>錯誤!超鏈接引用無效。</returns>description 返回值的說明。<returns> 標(biāo)記應(yīng)當(dāng)用于方法聲明的注釋，以描述返回值。<value><value>錯誤!超鏈接引用無效。</value>property-description 屬性的說明。<value> 標(biāo)記使您得以

30、描述屬性。請注意，當(dāng)在 Visual Studio .NET 開發(fā)環(huán)境中通過代碼向?qū)砑訉傩詴r，它將會為新屬性添加 <summary> 標(biāo)記。然后，應(yīng)該手動添加 <value> 標(biāo)記以描述該屬性所表示的值。4申明4.1每行聲明數(shù)一行只建議作一個聲明，并按字母順序排列。如： int level; /推薦 int size; /推薦 int x, y; /不推薦4.2初始化建議在變量聲明時就對其做初始化。4.3位置變量建議置于塊的開始處，不要總是在第一次使用它們的地方做聲明。如 void MyMethod() int int1 = 0; / beginning of met

31、hod blockif (condition)int int2 = 0; / beginning of "if" block . 不過也有一個例外 for (int i = 0; i < maxLoops; i+) . 應(yīng)避免不同層次間的變量重名，如int count;.void MyMethod() if (condition)int count = 0; / 避免 . .4.4類和接口的聲明1 在方法名與其后的左括號間沒有任何空格。2 左花括號 “”出現(xiàn)在聲明的下行并與之對齊，單獨(dú)成行。3方法間用一個空行隔開。4.5字段的聲明不要使用是 public 或 prot

32、ected 的實(shí)例字段。如果避免將字段直接公開給開發(fā)人員，可以更輕松地對類進(jìn)行版本控制，原因是在維護(hù)二進(jìn)制兼容性時字段不能被更改為屬性?？紤]為字段提供 get 和set 屬性訪問器，而不是使它們成為公共的。 get 和 set 屬性訪問器中可執(zhí)行代碼的存在使得可以進(jìn)行后續(xù)改進(jìn)，如在使用屬性或者得到屬性更改通知時根據(jù)需要創(chuàng)建對象。下面的代碼示例闡釋帶有g(shù)et 和 set 屬性訪問器的私有實(shí)例字段的正確使用。示例：public class Control: Component private int handle;public int Handle get return handle; 5 命名規(guī)

33、范5.1命名概述名稱應(yīng)該說明“什么”而不是“如何”。通過避免使用公開基礎(chǔ)實(shí)現(xiàn)（它們會發(fā)生改變）的名稱，可以保留簡化復(fù)雜性的抽象層。例如，可以使用 GetNextStudent()，而不是 GetNextArrayElement()。 命名原則是：選擇正確名稱時的困難可能表明需要進(jìn)一步分析或定義項的目的。使名稱足夠長以便有一定的意義，并且足夠短以避免冗長。唯一名稱在編程上僅用于將各項區(qū)分開。表現(xiàn)力強(qiáng)的名稱是為了幫助人們閱讀；因此，提供人們可以理解的名稱是有意義的。不過，請確保選擇的名稱符合適用語言的規(guī)則和標(biāo)準(zhǔn)。以下幾點(diǎn)是推薦的命名方法。1、避免容易被主觀解釋的難懂的名稱，如方法名AnalyzeT

34、his()，或者屬性名xxK8。這樣的名稱會導(dǎo)致多義性。2、在類屬性的名稱中包含類名是多余的，如 Book.BookTitle。而是應(yīng)該使用 Book.Title。3、只要合適，在變量名的末尾或開頭加計算限定符（Avg、Sum、Min、Max、Index）。4、在變量名中使用互補(bǔ)對，如 min/max、begin/end 和 open/close。 5、布爾變量名應(yīng)該包含 Is，這意味著 Yes/No 或 True/False 值，如 fileIsFound。6、在命名狀態(tài)變量時，避免使用諸如 Flag 的術(shù)語。狀態(tài)變量不同于布爾變量的地方是它可以具有兩個以上的可能值。不是使用 documen

35、tFlag，而是使用更具描述性的名稱，如 documentFormatType。 （此項只供參考）7、即使對于可能僅出現(xiàn)在幾個代碼行中的生存期很短的變量，仍然使用有意義的名稱。僅對于短循環(huán)索引使用單字母變量名，如 i 或 j。 可能的情況下，盡量不要使用原義數(shù)字或原義字符串，如For i = 1 To 7。而是使用命名常數(shù)，如 For i = 1 To NUM_DAYS_IN_WEEK 以便于維護(hù)和理解。5.2大小寫規(guī)則大寫標(biāo)識符中的所有字母都大寫。僅對于由兩個或者更少字母組成的標(biāo)識符使用該約定。例如：System.IOSystem.Web.UI下表匯總了大寫規(guī)則，并提供了不同類型的標(biāo)識符的示

36、例。標(biāo)識符大小寫示例類PascalAppDomain枚舉類型PascalErrorLevel枚舉值PascalFatalError事件PascalValueChange異常類PascalWebException 注意 總是以 Exception 后綴結(jié)尾。只讀的靜態(tài)字段PascalRedValue接口PascalIDisposable注意 總是以 I 前綴開始。方法PascalToString命名空間PascalSystem.Drawing屬性PascalBackColor公共實(shí)例字段PascalRedValue 注意 很少使用。屬性優(yōu)于使用公共實(shí)例字段。受保護(hù)的實(shí)例字段Camel redVa

37、lue注意 很少使用。屬性優(yōu)于使用受保護(hù)的實(shí)例字段。私有的實(shí)例字段CamelredValue參數(shù)CameltypeName方法內(nèi)的變量CamelbackColor5.3縮寫為了避免混淆和保證跨語言交互操作，請遵循有關(guān)區(qū)縮寫的使用的下列規(guī)則：1 不要將縮寫或縮略形式用作標(biāo)識符名稱的組成部分。例如，使用 GetWindow，而不要使用 GetWin。2不要使用計算機(jī)領(lǐng)域中未被普遍接受的縮寫。3在適當(dāng)?shù)臅r候，使用眾所周知的縮寫替換冗長的詞組名稱。例如，用 UI 作為 User Interface 縮寫，用 OLAP 作為 On-line Analytical Processing 的縮寫。4在使用縮

38、寫時，對于超過兩個字符長度的縮寫請使用 Pascal 大小寫或 Camel 大小寫。例如，使用 HtmlButton 或 HTMLButton。但是，應(yīng)當(dāng)大寫僅有兩個字符的縮寫，如，System.IO，而不是 System.Io。5不要在標(biāo)識符或參數(shù)名稱中使用縮寫。如果必須使用縮寫，對于由多于兩個字符所組成的縮寫請使用Camel 大小寫，雖然這和單詞的標(biāo)準(zhǔn)縮寫相沖突。5.4命名空間 1、命名命名空間時的一般性規(guī)則是使用公司名稱，后跟技術(shù)名稱和可選的功能與設(shè)計，如下所示。CompanyName.TechnologyName.Feature.Design2、命名空間使用Pascal大小寫，用逗號分

39、隔開。3、TechnologyName 指的是該項目的英文縮寫，或軟件名。4、命名空間和類不能使用同樣的名字。例如，有一個類被命名為Debug后，就不要再使用Debug作為一個名稱空間名。5.5類1、使用 Pascal 大小寫。2、用名詞或名詞短語命名類。3、使用全稱避免縮寫，除非縮寫已是一種公認(rèn)的約定，如URL、HTML 4、不要使用類型前綴，如在類名稱上對類使用 C 前綴。例如，使用類名稱 FileStream，而不是 CFileStream。5、不要使用下劃線字符 (_)。6、有時候需要提供以字母 I 開始的類名稱，雖然該類不是接口。只要 I 是作為類名稱組成部分的整個單詞的第一個字母，

40、這便是適當(dāng)?shù)?。例如，類名稱 IdentityStore 是適當(dāng)?shù)?。在適當(dāng)?shù)牡胤剑褂脧?fù)合單詞命名派生的類。派生類名稱的第二個部分應(yīng)當(dāng)是基類的名稱。例如，ApplicationException 對于從名為 Exception 的類派生的類是適當(dāng)?shù)拿Q，原因ApplicationException 是一種Exception。請在應(yīng)用該規(guī)則時進(jìn)行合理的判斷。例如，Button 對于從 Control 派生的類是適當(dāng)?shù)拿Q。盡管按鈕是一種控件，但是將 Control 作為類名稱的一部分將使名稱不必要地加長。public class FileStreampublic class Buttonpubli

41、c class String5.6接口 以下規(guī)則概述接口的命名指南：1、用名詞或名詞短語，或者描述行為的形容詞命名接口。例如，接口名稱 IComponent 使用描述性名詞。接口名稱 ICustomAttributeProvider 使用名詞短語。名稱 IPersistable 使用形容詞。2、使用 Pascal 大小寫。3、少用縮寫。4、給接口名稱加上字母 I 前綴，以指示該類型為接口。在定義類/接口對（其中類是接口的標(biāo)準(zhǔn)實(shí)現(xiàn)）時使用相似的名稱。兩個名稱的區(qū)別應(yīng)該只是接口名稱上有字母 I 前綴。5、不要使用下劃線字符 (_)。6、當(dāng)類是接口的標(biāo)準(zhǔn)執(zhí)行時，定義這一對類/接口組合就要使用相似的名

42、稱。兩個名稱的不同之處只是接口名前有一個I前綴。以下是正確命名的接口的示例。 public interface IServiceProvider public interface IFormatable以下代碼示例闡釋如何定義 IComponent 接口及其標(biāo)準(zhǔn)實(shí)現(xiàn) Component 類。 public interface IComponent / Implementation code goes here. public class Component: IComponent / Implementation code goes here.5.7屬性 (Attribute)應(yīng)該總是將后綴

43、Attribute 添加到自定義屬性類。以下是正確命名的屬性類的示例。public class ObsoleteAttribute 5.8枚舉 (Enum)枚舉 (Enum) 值類型從 Enum 類繼承。以下規(guī)則概述枚舉的命名指南：1、對于 Enum 類型和值名稱使用 Pascal 大小寫。2、少用縮寫。3、不要在 Enum 類型名稱上使用 Enum 后綴。4、對大多數(shù) Enum 類型使用單數(shù)名稱，但是對作為位域的 Enum 類型使用復(fù)數(shù)名稱。5、總是將 FlagsAttribute 添加到位域 Enum 類型。5.9參數(shù)以下規(guī)則概述參數(shù)的命名指南：1、使用描述性參數(shù)名稱。參數(shù)名稱應(yīng)當(dāng)具有足夠

44、的描述性，以便參數(shù)的名稱及其類型可用于在大多數(shù)情況下確定它的含義。2、對參數(shù)名稱使用 Camel 大小寫。3、使用描述參數(shù)的含義的名稱，而不要使用描述參數(shù)的類型的名稱。開發(fā)工具將提供有關(guān)參數(shù)的類型的有意義的信息。因此，通過描述意義，可以更好地使用參數(shù)的名稱。少用基于類型的參數(shù)名稱，僅在適合使用它們的地方使用它們。4、不要使用保留的參數(shù)。保留的參數(shù)是專用參數(shù)，如果需要，可以在未來的版本中公開它們。相反，如果在類庫的未來版本中需要更多的數(shù)據(jù)，請為方法添加新的重載。5、不要給參數(shù)名稱加匈牙利語類型表示法的前綴。6、如果參數(shù)用來表述數(shù)據(jù)表字段內(nèi)容的，數(shù)據(jù)類型必須和表字段類型保持一致。如：UserId為

45、int,不允許作為string類型來傳遞以下是正確命名的參數(shù)的示例。Type GetType(string typeName)string Format(string format, args() As object)5.10 方法以下規(guī)則概述方法的命名指南：1、使用動詞或動詞短語命名方法。2、返回類型應(yīng)為數(shù)據(jù)庫數(shù)據(jù)原始存儲的實(shí)際類型。比如：BokkType 正確的應(yīng)為int,如果方法返回的BookType為string,這樣的設(shè)計不允許，使用的地方根本就不知道返回的BookType到底什么。如果是返回值有不存在的情況，應(yīng)返回可空的強(qiáng)類型，而不應(yīng)該返回0表示沒有值。3、使用 Pascal 大小

46、寫。4、以下是正確命名的方法的實(shí)例。RemoveAll()GetCharArray()Invoke()5.11屬性 (property)以下規(guī)則概述屬性的命名指南：1、 使用名詞或名詞短語命名屬性。2、 返回類型應(yīng)為數(shù)據(jù)庫數(shù)據(jù)原始存儲的實(shí)際類型。3、 使用 Pascal 大小寫。4、 不要使用匈牙利語表示法。5、 考慮用與屬性的基礎(chǔ)類型相同的名稱創(chuàng)建屬性。例如，如果聲明名為 Color 的屬性，則屬性的類型同樣應(yīng)該是 Color。請參閱本主題中后面的示例。以下代碼示例闡釋正確的屬性命名。 public class SampleClass public Color BackColor / Cod

47、e for Get and Set accessors goes here. 以下代碼示例闡釋提供其名稱與類型相同的屬性。public enum Color / Insert code for Enum here.public class Control public Color Color Get/ Insert code here. set/ Insert code here. 以下代碼示例不正確，原因是 Color 屬性是 Integer 類型的。 public enum Color/ Insert code for Enum here. public class Control pub

48、lic int Color / Insert code here 在不正確的示例中，不可能引用 Color 枚舉的成員。Color.Xxx 將被解釋為訪問一個成員，該成員首先獲取 Color 屬性（ C# 中為 int 類型）的值，然后再訪問該值的某個成員（該成員必須是 System.Int32 的實(shí)例成員）。5.12 事件以下規(guī)則概述事件的命名指南：1、 對事件處理程序名稱使用 EventHandler 后綴。2、 指定兩個名為 sender 和 e 的參數(shù)。sender 參數(shù)表示引發(fā)事件的對象。sender 參數(shù)始終是object 類型的，即使在可以使用更為特定的類型時也如此。與事件相關(guān)聯(lián)

49、的狀態(tài)封裝在名為 e 的事件類的實(shí)例中。對 e 參數(shù)類型使用適當(dāng)而特定的事件類。3、 用 EventArgs 后綴命名事件參數(shù)類。4、 考慮用動詞命名事件。5、 使用動名詞（動詞的“ing”形式）創(chuàng)建表示事件前的概念的事件名稱，用過去式表示事件后。例如，可以取消的 Close 事件應(yīng)當(dāng)具有 Closing 事件和 Closed 事件。不要使用BeforeXxx/AfterXxx 命名模式。6、 不要在類型的事件聲明上使用前綴或者后綴。例如，使用 Close，而不要使用 OnClose。7、 通常情況下，對于可以在派生類中重寫的事件，應(yīng)在類型上提供一個受保護(hù)的方法（稱為 OnXxx）。此方法只應(yīng)

50、具有事件參數(shù) e，因為發(fā)送方總是類型的實(shí)例。以下示例闡釋具有適當(dāng)名稱和參數(shù)的事件處理程序。 public delegate void MouseEventHandler(object sender, MouseEventArgs e);以下示例闡釋正確命名的事件參數(shù)類。 public class MouseEventArgs : EventArgs int x; int y; public MouseEventArgs(int x, int y) this.x = x;this.y = y; public int Xgetreturn x; public int Y get return y;

51、 5.13 常量 (const)以下規(guī)則概述常量的命名指南：1、 所有單詞大寫，多個單詞之間用 "_" 隔開。如：public const string PAGE_TITLE = "Welcome"2、系統(tǒng)中僅推薦在Const.cs 和 ConstValue.cs 中聲明；3、頁面級文件【CNCECHSSE目錄下】和【SUBHSSE目錄下】中，不能按以上規(guī)則命名；4、其它未說明的地方，使用 Pascal 大小寫命名。5.14 字段以下規(guī)則概述字段的命名指南：1、 private、protected 使用 Camel 大小寫。2、 public 使用 Pa

52、scal 大小寫。3、 拼寫出字段名稱中使用的所有單詞。僅在開發(fā)人員一般都能理解時使用縮寫。字段名稱不要使用大寫字母。下面是正確命名的字段的示例。class SampleClass string url; string destinationUrl;4、 不要對字段名使用匈牙利語表示法。好的名稱描述語義，而非類型。5、 不要對字段名或靜態(tài)字段名應(yīng)用前綴。具體說來，不要對字段名稱應(yīng)用前綴來區(qū)分靜態(tài)和非靜態(tài)字段。例如，應(yīng)用 g_ 或 s_ 前綴是不正確的。6、 對預(yù)定義對象實(shí)例使用公共靜態(tài)只讀字段。如果存在對象的預(yù)定義實(shí)例，則將它們聲明為對象本身的公共靜態(tài)只讀字段。使用 Pascal 大小寫，原因是字段是公共的。下面的代碼示例闡釋公共靜態(tài)只讀字段的正確使用。public struct Colorpublic static readonly Color Red = new Color(0x0000FF);public Color(int rgb) / Insert code here. public Color(byte r, byte g, byte b) / Insert code here. public byte RedValue g