NET开发规范.doc

.NET 开发规范  我们应该知道规范对于系统的生命周期多么重要，试想如果每个程序员写的程序其他人都难以阅读，最后只能由他本人去维护、修改的话，软件开发将是什么样的噩梦。 MS为大家提供了FXCop工具，它用于自动检查代码的规范性、安全性甚至效率，所以，本文将围绕MS提供的C#.NET代码规范展开，以利于使用FXCop来自动校验我们的代码。 我以前曾经发布过《.NET编程规范个人总结》，但该文与FXCop的检测有相当的出入，所以我修改了该文，为此我深表歉意。 ? FXCop工具下载地址：/team/fxcop 1、命名约定 Pascal和Camel命名约定 编程的命名方式主要有Pascal和Camel两种（Pascal：每个单词的首字母大写，例如ProductType。Camel：首个单词的首字母小写，其余单词的首字母大写，例如productType）。 ? 标志符 规则 实例与描述 类class Pascal Application 枚举类型enum Pascal 记住，是以Pascal命名，切勿包含Enum，否则FXCop会抛出Issue 委托delegate Pascal 以Pascal命名，不以任何特殊字符串区别于类名、函数名 常量const Pascal 仍然提倡使用Pascal命名，以能通过FXCop检测 接口interface Pascal IDisposable 注：总是以 I 前缀开始，后接Pascal命名 方法function Pascal ToString 命名空间namespace Pascal 以.分隔，当每一个限定词均为Pascal命名方式，比如： using ExcelQuicker.Framework 参数 Camel 首字母小写 局部变量 Camel 也可以加入类型标识符，比如对于System.String类型，声明变量是以str开头，string strSQL = string.Empty; 数据成员 — 以m开头＋Pascal命名规则，如mProductType（m意味member） 属性 Pascal ? ? 1.1、局部变量命名 在primitive的局部变量命名时，使用Camel命名规则， 比如：int type = 0; double count = 0; … 对于string类型定义，通常使用str前缀＋Pascal命名的方式， 比如string strSQL = string.Empty; 这是一种典型的命名SQL语句字符串的方式 ? 而对于此外的类型对象定义，通常的做法是使用obj前缀＋Pascal命名的方式，来告知我们这个变量是一个对象 比如：Application obj Application = new Application(); ? 1.2、参数命名 Camel命名规则，首字母小写 ? 1.3、类数据成员/属性命名 数据成员命名以m开头＋Pascal命名方式； 属性以Pascal命名 比如 class EQAppcalition { private ArrayList mWorksheetCollection = new ArrayList(); public ArrayList WorksheetCollection { get { return this.mWorksheetCollection; } } } 另外，在类的内部调用时，我们应该尽量加上this限定符，this在编辑环境中是蓝色的，更利于我们区分局部变量、参数或静态变量 ? 1.4、命名空间命名 在.之间的限定字符串符合Pascal格式 ? 1.5、委托缩写 委托的命名方式我常常以Pascal命名，或者可以在前面加入On 比如public delegate void OnMouseUp (object sender, MouseEventArgs e);用于处理当Mouse Up时触发的委托 ? 1.6、自定义异常类 我建议自定义异常类以Exception结尾， 比如class EQException: Exception{…} 这是在我的ExcelQuicker控件中异常类的定义方式 1.7、枚举 枚举的命名是Pascal命名，不要像我在以前C++中命名时还在变量头加Enum，看上去挺别扭的。在枚举的使用当中，我们不应该对枚举进行类型转换，以前我最常发生的事情就是将枚举与INT类型转来转去，这样破坏了使用枚举enum的初衷 ? 1.8、常量命名 以Const开头＋Pascal命名，或者直接是Pascal命名方式 ? 1.9、命名缩写 在一般情况下，我们都不要使用缩写命名，我们从来不害怕长的变量命名，而却担心看