.net 编码规范小结

 

 

一．编程书写规范

良好的编码规范能让代码简明清晰，易于阅读，提高团队开发的效率。

首先总结代码的命名规范:

一般有3种命名规范：

1.     Pascal规范: 名字中的每一个逻辑断点都用一个大写字母来标记；如:MyData

2.     Camel(骆驼法)规范：与帕斯卡命名相似。只不过Camel命名法是首字母小写，而帕斯卡命名法是首字母大写。如:myData

3.     匈牙利命名法: 名字＝属性＋类型＋对象描述，其中每一对象的名称都要求有明确含义，如:iMyData(i说明了变量的类型)

微软目前比较推荐Pascal和Camel规范。

具体的一些使用总结：

编程规范
类型	命外规则	说明
命名空间 namespace	Pascal	以.分隔，其中每一个限定词均为Pascal命名方式  如ExcelQuicker.Work
类       class	Pascal	每一个逻辑断点首字母大写 如public class MyHome
接口     interface	IPascal	每一个逻辑断点首字母大写,总是以I前缀开始，后接Pascal命名 如public interface IBankAccount
方法     method	Pascal	每一个逻辑断点首字母大写 如private void SetMember(string)
枚举类型enum	Pascal	每一个逻辑断点首字母大写
委托    delegate	Pascal	每一个逻辑断点首字母大写
局部变量 方法的参数	Camel	首字母小写，之后Pascal命名 如string myName

 

一些良好习惯
1、	成员变量前加前缀 _
2、	接口的名称加前缀I
3、	自定义的属性以Attribute结尾，如： public class AuthorAttribute ：Attribute { }
4、	自定义的异常以Exception结尾，如： public class AppException： Exception { }
5、	方法的命名。一般将其命名为动宾短语，如： ShowDialog（） CreateFile（）
6、	代码的缩进。要用Tab，而不要用space.
7、	局部变量的名称要有意义。不要用x，y，z等等（除用于For循环变量中可使用i，j，k，l，m，n）。
8、	所有的成员变量声明在类的顶端，用一个换行把它和方法分开。
9、	用有意义的名字命名namespace，如：产品名、公司名。
10、	生成和构建一个长的字符串时，一定要使用StringBuilder，而不用string。
11、	始终使用”{  }”包含if下的语句，即使只有一条语句。
12、	把相似的内容放在一起，比如数据成员、属性、方法、事件等，并适当的使用#region…#endregion

 

二．异常处理

滥用try{}Catch{}来捕获异常会降低系统的性能。建议try{}Catch{}要有明显的针对性，如：

Try

{

  //code

}

Catch(NullReferenceException)

{

  //nullreference exception

}

Catch(System.Data.SalClient.SqlException)

{

  //sqlexception

}

Catch

{

   //other exception

}