avsol_coding_guidelines_for_csharp_3.0_and_4.0

《avsol_coding_guidelines_for_csharp_3.0_and_4.0》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、CodingGuidelinesforC#3.0andC#4.0CodingGuidelinesforC#3.0andC#4.0June2010www.csharpcodingguidelines.comDennisDoomenwww.avivasolutions.nlConceptwww.dennisdoomen.netCodingGuidelinesforC#3.0andC#4.01Introduction1.1Whatisthis?Thisdocumentattemptstoprovideusefulandpragmaticguidelinesforprogrammingi

2、nC#3.0andC#4.0thatweatAvivaSolutionsalreadyuseinourday-to-daywork.Codingguidelines,orcodingstandardsifyouwill,aredocumentsconsistingofrulesandrecommendationsontheuseofC#inenterprisesystems.Theydealwithcodelayout,namingguidelines,theproperuseofthe.NETFramework,tipsonwritingusefulcommentsandXML

3、documentation,andoftenalsoincludeguidanceonproperobject-orienteddesign.VisualStudio’sStaticCodeAnalysis(a.k.a.FxCop)andStyleCopcanautomaticallyverifyamajorityofthoserulesandrecommendationsbyanalyzingthecompiledassemblies.Youcanconfiguretodothatatcompiletimeoraspartofacontinuousordailybuild.Th

4、isdocumentaddsadditionalrulesandrecommendationsanditscompanionsite,www.csharpcodingguidelines.comprovidesalistofCodeAnalysisrulesthatareapplicableforLine-of-Businessapplicationsandframeworks.1.2Whyareguidelinesnecessary?Becausenoteverydeveloperisawareofthepotentialpitfallsofcertainconstructi

5、onsinC#.isintroducedintocertainconventionswhenusingthe.NETFramework(e.g.IDisposable)isawareoftheimpactofusing(orneglectingtouse)particularsolutionsonaspectslikesecurity,performance,multi-languagesupport,etc.knowsthatnoteverydeveloperisascapableinunderstandinganelegant,butabstract,solutiona

6、stheoriginaldeveloper.Althoughcomplyingwithcodingguidelinesmayseemtoappearasundesiredoverheadormaylimitcreativity,thisapproachhasalreadyprovenitsvalueformanyyears.Alsobewareofthefactthatnotallcodingguidelineshaveaclearrationale.SomeofthemaresimplychoiceswemadeatAvivaSolutions.1.3BasicPrincipl

7、esTherearemanyunexpectedthingsIrunintoduringmyworkasaconsultant,eachdeservingatleastoneguideline.Unfortunately,I’mstilltryingtokeepthisdocumentwithinareasonablesize.Butunliketowhatsomejuniordevelopersbelieve,thatdoesn’tmeanthatwhensomethingis