資源描述:
《c代碼規(guī)范范本》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在工程資料-天天文庫。
1、C#編碼規(guī)范目錄方針該代碼標(biāo)準(zhǔn)提供了相關(guān)軟件開發(fā)項(xiàng)目中,使用C#進(jìn)行編碼吋的規(guī)則,推薦代碼標(biāo)進(jìn),起到了一定的指示作用。為了使該標(biāo)準(zhǔn)制定的方針淺顯易懂,用了簡(jiǎn)單的代碼來編寫。而在實(shí)際的編程中,是需要項(xiàng)目小組所有成員同意該編寫規(guī)則的。對(duì)于實(shí)際項(xiàng)目,我們推薦將該標(biāo)準(zhǔn)以顧客為標(biāo)準(zhǔn)使用。還有,我們還推薦讀者參考配合.NETFrameworkSDK幫助的《面向?qū)ο箝_發(fā)設(shè)計(jì)指南》。探特別是在ExtremeProgramming項(xiàng)目中沒有認(rèn)識(shí)到的,可使用英它C#編程的項(xiàng)日中運(yùn)用。1.代碼注釋規(guī)范(1)文件功能,創(chuàng)建,修改信息注釋(2)類功能注釋(3)方法注釋(4)較長(zhǎng)的注釋,
2、*GY需要復(fù)數(shù)行注釋的情況下,在最初用短小的篇章寫上想要注釋什么。然后在添加上長(zhǎng)的注釋。另外,在感覺有必耍寫象如此長(zhǎng)的注釋之時(shí),請(qǐng)?jiān)偃紤]一下,可否將程序設(shè)計(jì)再簡(jiǎn)化一下。請(qǐng)積極地應(yīng)對(duì)。1.目錄文件構(gòu)成(5)目錄文件名Public類會(huì)生成一個(gè)以該類命名的文件。例:publicclassCustomer里面有著Customer.cs0包內(nèi)的非公共類,最好放在包含該類經(jīng)常被使用的公共類目錄文件下。對(duì)于特殊類,一個(gè)日錄文件可以包含多個(gè)類。(6)目錄文件的位置決定了項(xiàng)目的根目錄之后,在命名空間的處輸入導(dǎo)入日錄的階層位置。可是對(duì)應(yīng)于solution/project的命名空
3、間的階層則用solution名/project名作為目錄名來使用。例:命名空間:CompanyName.OrganizationName.TechnologyName.CoreFeatureName.SubFeatureNameSolutionSoIutionName所對(duì)應(yīng)的命名空間:TechnoIogyNameProjectProjectName所對(duì)應(yīng)的命名空間:CoreFeatureName配置路徑:C:¥CompanyName¥OrganizationName¥SolutionName¥ProjectName¥SubFeatureName(6)TestC
4、lass名類ClassName的單元測(cè)試類是以ClassNameTest來命名的。Solution的每個(gè)測(cè)試都是以SolutionNameTests來命名的。例:如果是Customer類的測(cè)試類的話就命名為CustomerTest.cs。例:如果是CsSampIe的souItion的話,就把它命名為CsSampIeTests,csprojo理由:因?yàn)槭沁@樣命名是非常有一致性??梢猿蔀槭褂脺y(cè)試代碼的樣例和演示版。(7)TestClass的位置測(cè)試類的位置應(yīng)配置在被測(cè)試類相同的階層的目錄下。例:被測(cè)試類的位置:測(cè)試類的位置:理由:如果不是物理位置較近的話,會(huì)被維護(hù)
5、系統(tǒng)所遺漏。對(duì)于產(chǎn)品的代碼分離這一點(diǎn)而言,用其他的工具(NAnt的build文件之類)也是可能調(diào)整的。1.命名規(guī)則⑼NameSpace結(jié)構(gòu)規(guī)范NameSpace分類和命名原則先根據(jù)解決方案(Solution)、業(yè)務(wù)系統(tǒng)(Application)、子系統(tǒng)(Sub)、模塊(Module)劃分目錄,然后在模塊內(nèi)部按照Web、Biz>integration層對(duì)NameSpace結(jié)構(gòu)進(jìn)行命名。Web層NameSpace命名規(guī)范Beyondbit.Solution.Application.Sub.Module.Web業(yè)務(wù)層NameSpace命名規(guī)范Beyondbit.So
6、lution.Application.Sub.Module.Biz數(shù)據(jù)訪問層NameSpace命名規(guī)范?Beyondbit.Solution.Application.Sub.Data集成層NameSpace命名規(guī)范Beyondbit.Solution.Application.Sub.Module.BizCommon該目錄應(yīng)用于解決方案(Solution)>業(yè)務(wù)系統(tǒng)(application)、子系統(tǒng)(sub),存放在一些與業(yè)務(wù)相關(guān)的通用處理程序,可以視為公共的模塊,可包含Web、Biz^integration。Util該目錄應(yīng)用于解決方案(Solution)、業(yè)
7、務(wù)系統(tǒng)(Application)、子系統(tǒng)(Sub),存放在一些與業(yè)務(wù)無關(guān)的通用處理程序。(10)文件名Public類的命名一定要與文件名同名(包括大,小寫的區(qū)別)o(11)類名類名使用Pascal大小寫形式。(12)異常類名最后以Exception結(jié)尾。(13)接口名與類名相同。此外,經(jīng)常在最前面添加I。interfaceICIassName此外,在使用添加了某項(xiàng)功能的情況下,我們要加上可以表示這種功能的形容詞,以-able結(jié)尾。例:IEnumerable,ICIoneable,IXmlSerializable,...(11)抽象類名如果沒有適合抽象類名的名字
8、的時(shí)候,就聯(lián)想以Abstract為開頭