中證期貨研究部軟件開發(fā)命名規(guī)范(C#版)

1、中證期貨研究部軟件開發(fā)命名規(guī)范（C#版）本文檔只適用于C#語言以及其實(shí)現(xiàn)的.NET Framework公共類型系統(tǒng)（CTS）第一部分.NET C#編碼規(guī)范一簡介一、使用編碼規(guī)范的目標(biāo)定義一些原則以保證編碼格式的一致性，提高代碼的可讀性和可維護(hù)性，并保護(hù)開發(fā)人員盡量減少由編碼引起的錯(cuò)誤。二、術(shù)語和定義1. Camel命名法第一個(gè)單詞的首字母小寫，后續(xù)各單詞的首字母均大寫。例：depName2. Pascal命名法第一個(gè)單詞首字母大寫，后續(xù)個(gè)單詞的首字母也大寫。3 .公共類型系統(tǒng).NET Framework公共類型系統(tǒng)（CTS）定義如何聲明、使用和管理類型。所有本地的C#類型都基于CTS，支持跨語

2、言集成。4. 標(biāo)識符自定義的標(biāo)記，用于唯一命名對象或?qū)ο髮?shí)例例：public class MyclassOfPersonal第二部分 命名相關(guān)（規(guī)范）一、通用規(guī)則1. 始終使用 Camel命名法或 Pascal命名法。2. 避免使用全部大寫和全部小寫的名稱，單個(gè)小寫單詞或字母是允許的。3. 不要創(chuàng)建只按照大寫而改變的命名空間、類、方法、屬性、字段或參數(shù)。4. 不要使用以數(shù)字字符開頭的名稱。5. 選擇有意義且特定的名稱。6. 盡量使用詳盡而不過于簡潔的命名。7. 變量和屬性應(yīng)該描述實(shí)體而不是類型或大小。8. 不推薦使用匈牙利命名法。9. 避免使用縮略語，除非全程過長。10. 避免使用超過5個(gè)字符

3、的縮略語。11. 所有的縮略語都必須為大家所熟知和接受。12. 對兩個(gè)字母的縮略語使用小寫，而對較長的縮略語使用Pasca I命名法。13. 不使用C#保留字作為名稱。14. 避免命名與現(xiàn)有.NET Framework命名空間或類型沖突。15. 避免向標(biāo)識符添加冗長或沒有意義的前綴和后綴。16. 不要在屬性名稱中包含父類名稱。17. 盡量將Can Is Has用做布爾變量和屬性的前綴。18. 在適當(dāng)?shù)牡胤綄⒂?jì)算限定符附加給變量名稱，如Average、Count、Sum、Min、Max19. 定義根命名空間時(shí)，請將產(chǎn)品名、公司名或開發(fā)人員姓名作為根。20. 類、接口、變量以及數(shù)據(jù)庫表名、字段名等

4、的命名都需要用有意義的英文單詞命名，不能使用中文拼音，如 XinYongKa這種方法，更不能使用中文拼音的縮寫，如XYK。變量名中不要使用下劃線“ _”。21. 不要使用單個(gè)字符作為變量名，如使用單個(gè)字母的變量象i, n, t等，而應(yīng)使用index、number、temp等完整的有意義的單詞。i變量只用于迭代計(jì)數(shù)（如for循環(huán)里的i），不能在循環(huán)迭代的其他地方出現(xiàn)。二、細(xì)化規(guī)則項(xiàng)目文件：Pascal命名法。始終將程序集名稱與根命名空間匹配。源文件：Pascal命名法，始終將類名與文件名匹配。避免每個(gè)文件包括多個(gè)類、枚舉（全 局）或委托（全局）。包含多個(gè)類、枚舉或委托時(shí)，使用描述性文件名。資源或

5、嵌入式文件：盡量使用Pascal命名法。使用描述文件內(nèi)容的名稱。命名空間：Pascal命名法。盡量與醒目/程序集名稱部分匹配。類或結(jié)構(gòu)：Pascal命名法。用名詞或名詞短語作為類名稱。如果可能，在為其他類型劃分 子類是添加相應(yīng)的類后綴。接口： Pascal命名法。用大寫字母I作為接口名稱的前綴。方法：Pascal命名法。盡量使用動詞或動詞與對象組合。屬性：Pascal命名法。屬性名稱應(yīng)該表示其返回的實(shí)體。絕對不要將Get或Set用作屬性名稱的前綴。常量或靜態(tài)字段：作為字段處理，選擇以上相應(yīng)的字段訪問修飾符。常量名均為大寫，字之間用下劃線分隔枚舉：使用Pascal命名法（類型和選項(xiàng)），枚舉類型以

6、復(fù)數(shù)結(jié)尾。如：enum Colors Red, Black, Blue委托或事件：作為字段處理，選擇以上相應(yīng)的字段訪問修飾符。參數(shù)：Camel命名法。三、代碼注釋1、使用或/,不使用/*1。2、不要使用行內(nèi)注釋解釋明顯易懂的代碼，質(zhì)量高的編碼具有自解釋性能。注釋（Comment規(guī)范注釋規(guī)范包括：模塊（類）注釋規(guī)范、類的屬性、方法注釋規(guī)范、代碼間注釋（1）模塊（類）注釋規(guī)范 模塊開始必須以以下形式書寫模塊注釋：/模塊編號： /作用： /作者：作者中文名/編寫日期： /如果模塊有修改，則每次修改必須添加以下注釋：/ Log編號：/修改描述： /作者：修改者中文名/修改日期： /(2) 類屬性注釋規(guī)

7、范在類的屬性必須以以下格式編寫屬性注釋：/ III屬性說明/ (3) 方法注釋規(guī)范在類的方法聲明前必須以以下格式編寫注釋/ / 說明： / / vparam name=/ / / (4) 代碼間注釋規(guī)范代碼間注釋分為單行注釋和多行注釋：單行注釋：/多行注釋：/*多行注釋1多行注釋2多行注釋3*/代碼中遇到語句塊時(shí)必須添加注釋(if,for,foreach, ),添加的注釋必須能夠說明此語句塊的作用和實(shí)現(xiàn)手段(所用算法等等)。第三部分.NET C#編碼規(guī)范一編碼風(fēng)格(此部分推薦，非強(qiáng)制)編碼風(fēng)格：以下描述實(shí)現(xiàn) C#源代碼推薦的方法，以便創(chuàng)建易于理解、易于維護(hù)、可讀性強(qiáng)、 結(jié)構(gòu)清晰并且前后一致的代

8、碼。一、格式設(shè)置：1、每個(gè)文件不要聲明多個(gè)命名空間。2、避免在單個(gè)文件中放置多個(gè)類。3、將大括號和放置于新行。4、 在條件語句中使用大括號和。5、使用大小為4的制表符和縮進(jìn)。6、獨(dú)立聲明每個(gè)變量，即不在同一個(gè)語句中聲明多個(gè)變量。7、 將命名空間和using語句置于文件頂部。將命名空間分組為.NET命名空間和自定義命名 空間。8、按照以下順序按類型對內(nèi)部類進(jìn)行分組。成員變量。構(gòu)造函數(shù)與析構(gòu)函數(shù)。嵌套枚舉、結(jié)構(gòu)和類。屬性。方法。9、根據(jù)訪問修飾符和可見性為類型中的序列聲明分組。PublicProtectedIn ternalPrivate10、將文件夾名稱附加到子文件夾內(nèi)源文件的命名空間。11、遞

9、歸縮進(jìn)括號內(nèi)包含的所有代碼塊。12、 使用空白（回車符/換行符、制表符等）分割和組織代碼。13、將程序集范圍的屬性聲明放置于一個(gè)單獨(dú)的行。14、將類型范圍的屬性聲明放置在一個(gè)單獨(dú)的行。15、將方法范圍的屬性聲明放置在一個(gè)單獨(dú)的行。16、將成員范圍的屬性聲明放置在一個(gè)單獨(dú)的行。17、將參數(shù)屬性是聲明于參數(shù)內(nèi)聯(lián)。18、如果存有疑問，結(jié)構(gòu)清晰、前后一致為原則。父親的格局決定家庭的方向一個(gè)家庭的福氣運(yùn)道，不是憑空出現(xiàn)的，它是家庭成員共同努力得來的。曾國藩曾說： 謀大事者首重格局”心中格局的大小，決定了眼光是否長遠(yuǎn)，眼光是否長遠(yuǎn)又決定了事物的成敗家庭的發(fā)展不是一個(gè)一蹴而就的過程，家庭需要經(jīng)營，需要規(guī)劃。

10、由于社會分工的不同，父親作為家庭中的男性，承擔(dān)著家庭領(lǐng)導(dǎo)者的職能，是家庭權(quán)威”的代表。作為家庭列車的火車頭，父親的眼光要遠(yuǎn)，格局要大，只有父親的格局大，才能確保家庭的發(fā)展方向不出錯(cuò)。老話說 不是一家人，不進(jìn)一家門 ”人的一生中有大部分時(shí)間都在家庭中度過，觀念、思想等都會通過家人間潛移默化的影響來傳遞。如果父親有一個(gè)大格局，那在他的妻子、后輩子孫都 會受到好的影響。在家庭生活中，父親有大格局，就是在家庭遭遇困難或變故時(shí)，不退縮，能夠頂住壓力。對待家庭小的損失不斤斤計(jì)較，不渾渾噩噩混日子，積極對待生活，對于家庭發(fā)展有大致的規(guī)劃。蒙田曾說： 作為一個(gè)父親，最大的樂趣就在于：在其有生之年，能夠根據(jù)自己走過的路來啟發(fā)教育子女?！币粋€(gè)父親勝過一百個(gè)老師，