C#最佳实践规则

《C#最佳实践规则》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、命名规范1•利用Pascal的方式定义类型、方法名和常量publicclassSomeClass{constintDefaultSize=100;publicSomeMethod(){}}2.对于局部变量和方法的参数使用骆驼命名法intnumber;voidMyMethod(intsomeNumber){}3•接口的名称前加上IinterfaceImyInterface4.在私有成员变量前面加上m_。对于m_后面的变量名使用骆驼命名方法publicclassSomeClass{privateintm_Number;}5•对白定义的属性类加上后缀Attr

2、ibute6•对口定义的异常类加上后缀Exception7.方法的命名使用动词…-对彖对，例如ShowDialog（）8.冇返回值的方法的命名中要冇返回值的描述，例如GetObjectState（）9•使用带冇说明性的变暈名a）避免单字符的变量名，例如I或t等。使用类似于index或temp这样有意义的名字。b）对■J：public或protected类型的变量避免使用匈牙利表示法。c）不要缩写单词（例如用num取代number）。10•总是使用C#预定义而不要使丿IJSystem名称空间屮的别乳例如：使用object而不是Object使用string

3、而不是String使用int而不是int3211.在使用泛型的时候，类型的首字母耍大写。当处理.NET中的Type类型的时候，保留Type后缀°(C#2.0新特性)〃正确publicclassLinkedList{..}〃避免publicclassLinkedList{....}12使用有意义的名字定义名称空间，例如产品名或者公司名13.避免通过全限定方式使用类型名称，使用using关键字。14•避免在一个名称空间中使用using关键字15•把所有系统框架提供的名称空间组织到一起，把第三方提供的名称空间放到

4、系统名称空间的下面usingSystem;usingSystem.Collection.Generic;usingSystem.ComponentModel;usingSystem.Data;usingMyCompany;usingMyControls;16.使用代理推导而不要显式的实例化一个化代理(C#2.0新特性)delegatevoidSomeDelegate();publicvoidSomeMethod(){•••}SomeDelegatesomeDelegate=SomeMethod;17•维护严格的代码缩进。不要使用tabs或非标准的缩进，

5、例如一个空格。推荐的缩进是3到4个空格。18•在和你的代码缩进处于同一个级别处为该行代码添加注释。19•所有的注释都应该通过拼写检查。注释屮的错课拼写意味着开发进度的延缓。20•所有的类成员变量应该被声明在类的顶部，并用一个空行把它们和方法以及属性的声明区分开publicclassMyClass{intm_Number;stringm_Name;publicvoidSomeMethod1();publicvoidSomeMethod2();}21•在最靠近•-个局部变量被使用的地方声明该局部变量。22.—个文件名应该能够反映它所对应的类名23.当使用一

6、个部分类并把该类分布到不同的文件中时，在每一个文件名末尾都加上该文件实现的部分在类整体中扮演的作用。例如：//InMyClass.cspublicpartialclassMyClass{•••}//InMyClass.Designer.espublicpartialclassMyClass{•••}24.总是要把花括号“{”放在新的一行编码实践：1.避免在同一个文件中放置多个类2.一个文件应该只向在一个名称空间内定义类型。避免在一个文件中使用多个名称空间3.避免在一个文件内写多T500行的代码(机器口动心成的代码除外)1.避免写超过25行代码的方法2.

7、避免写超过5个参数的方法。如果要传递多个参数，使用结构。3.一行不要超过80个字符4.不要手动去修改任何机器生成的代码a)如果修改了机器生成的代码，修改你的编码方式來适应这个编码标准b)尽可能使用partialclasses特性，以提高可维护性。(C#2.0新特性)5.避免对那些很直观的内容作注释。代码本身应该能够解释其本身的含义。由可读的变量名和方法名构成的优质代码应该不需耍注释。6.注释应该只说明操作的一些前提假设、算法的内部信息等内容。7.避免对方法进行注释a)使用充足的外部文档对API进行说明b)只有对那些其他开发者的提示信息才有必要放到方法级

8、的注释中来11•除了0和1,绝对不要对数值进行硬编码，通过声明一个常量來代替该数值11.只对那