C#开发编码规范

《C#开发编码规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、C#开发常用编码规范注记：Pascal大小写形式——所有单词第一个字母大写，其他字母小写。Camel大小写形式——除了第一个单词，所有单词第一个字母大写，其他字母小写。1.类名、方法、常量使用Pascal大小写形式publicclassHelloWorld{constintDefaultSite=100;publicSomeMethod(){……}}2.局部变量、方法参数使用Camel大小写形式publicclassHelloWorld{inttotalCount=0;voidSayHello(string

2、name){stringfullMessage="Hello"+name;…}}3.接口命名加前缀IInterfaceIMyInterface{…}4.方法命名使用动词+对象的组合方式，如ShowDialog()5.自定义的特性(attribute)类加Attribute后缀6.自定义的异常(exception)类加Exception后缀7.带返回值的方法应该有一个描述性的名称，如GetObjectState()8.使用描述性变量命名。a)避免使用单字符的变量名，如i或t，用index或temp代替b)避免

3、使用匈牙利命名法命名public或protected成员变量c)不用使用单词缩写（比如用num代替number）9.使用C#预定义的类型，不要使用System命名空间的别名，比如：用object不用Object用string不用String用int不用Int3210.使用有意义的命名空间，比如产品名称或公司名称11.避免使用完整的类型名称，要使用using声明，避免把using声明放入到命名空间12.把所有的框架命名空间(namespace)放在一起，把自定义的或第三方的放在最后usingSystem;us

4、ingSystem.Collections.Generic;usingSystem.ComponentModel;usingSystem.Data;usingMyCompany;usingMyControls;13.文件名要和类名匹配，例如，对于类HelloWorld，相应的文件名应为helloworld.cs14.缩进和间隔a)缩进用TAB。不用SPACES。注释需和代码对齐。花括弧({})需和括号外的代码对齐。用一个空行来分开代码的逻辑分组。boolSayHello(stringname){string

5、fullMessage="Hello"+name;DateTimecurrentTime=DateTime.Now;stringmessage=fullMessage+",thetimeis:"+currentTime.ToString();MessageBox.Show(message);if(…){//Dosomething//…returnfalse;}returntrue;}b)在一个类中，各个方法需用一空行，也只能是一行分开。花括弧需独立一行，而不象if，for等可以跟括号在同一行。好：if(…)

6、{//Dosomething}不好：if(…){//Dosomething}c)在每个运算符和括号的前后都空一格。好：if(showResult==true){for(inti=0;i<10;i++){//}}不好：if(showResult==true){for(inti=0;i<10;i++){//}}15.避免使用大文件。如果一个文件里的代码超过300～400行，必须考虑将代码分开到不同类中。避免写太长的方法。一个典型的方法代码在1～25行之间。如果一个方法代码超过25行，应该考虑将其分解为不同的方法

7、。方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然，就无需用文档来解释方法的功能了。好：voidSavePhoneNumber(stringphoneNumber){//Savethephonenumber.}不好：//Thismethodwillsavethephonenumber.voidSaveData(stringphoneNumber){//Savethephonenumber.}16.一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小。好：//Saveth

8、eaddress。voidSaveAddress(stringaddress){//Savetheaddress.//…}//Sendanemailtothesupervisortoinformthattheaddressisupdated.voidSendEmail(stringaddress,stringemail){//Sendanemailtoinformthesupervisorthattheaddre