2014的命名规.docxVIP

C#的命名规范1、命名约定Pascal和Camel命名约定编程的命名方式主要有Pascal和Camel两种（Pascal：每个单词的首字母大写，例如ProductType；Camel：首个单词的首字母小写，其余单词的首字母大写，例如productType）以下是一些常用的C#成员及其推荐命名方法： 标志符规则实例与描述类classPascalApplication枚举类型enumPascal记住，是以Pascal命名，切勿包含Enum，否则FXCop会抛出Issue委托delegatePascal以Pascal命名，不以任何特殊字符串区别于类名、函数名常量const全部大写全部大写，单词间以下划线隔开接口interfacePascalIDisposable 注：总是以 I 前缀开始，后接Pascal命名方法functionPascalToString命名空间namespacePascal以.分隔，当每一个限定词均为Pascal命名方式，比如：using ExcelQuicker.Framework参数Camel首字母小写局部变量Camel也可以加入类型标识符，比如对于System.String类型，声明变量是以str开头，string strSQL = string.Empty;数据成员Camel以m开头＋Pascal命名规则，如mProductType（m意味member）属性Pascal1.1、局部变量命名在primitive的局部变量命名时，使用Camel命名规则，比如：int type = 0;double count = 0;…对于string类型定义，通常使用str前缀＋Pascal命名的方式，比如string strSql = ; //这是一种典型的命名SQL语句字符串的方式。而对于此外的类型对象定义，通常的做法是使用obj前缀＋Pascal命名的方式，来告知我们这个变量是一个对象。或者也可以直接使用类名的Camel命名规则。比如：Application objApplication = new Application(); Application application = new Application();1.2、参数命名Camel命名规则，首字母小写1.3、类数据成员/属性命名，数据成员命名以Camel命名方式，而属性以Pascal命名。通常如果数据成员与属性成对的话，数据成员与属性的命名区别仅在于变量名的第一个字母是小写还是大写。比如class Appcalition{ private ArrayList worksheetCollection = new ArrayList(); public ArrayList WorksheetCollection { get { return this.worksheetCollection; } }}另外，类的成员数据/方法调用时，应该加上this限定符，this在编辑环境中是蓝色的，更利于我们区分局部变量、参数或静态变量，并且利于FXCop检测区分。（如果使用FxCop扫描和检测代码的话）1.4、命名空间命名在dot之间的各限定字符串符合Pascal格式1.5、委托缩写委托的命名方式我常常以Pascal命名，并且在命名的后面加EventHandler比如public delegate void MouseEventHandler (object sender, MouseEventArgs e); //用于处理与鼠标相关的事件或委托对于自定义的委托，其参数第一个建议仍然使用object sender，sender代表触发这个时间或委托的源对象。而第二个参数继承于EventArgs类，并且在派生类中实现自己的业务逻辑。1.6、自定义异常类自定义异常类以Exception结尾，并且在类名中能清楚的描述出该异常的原因。比如NotFoundFileException，描述出了某个实体（文件、内存区域等）无法被找到。1.7、枚举枚举的命名是Pascal命名，不需要在枚举中加入Enum，枚举的名称能清楚的表明该枚举的用途。1.8、常量命名全部大写，单词间并且以下划线间隔，如public const int LOCK_SECONDS = 3000; 虽然在MSDN中常量的命名推荐使用Pascal，但是从C++沿袭的命名规则来看，将常量全部大写更加能清楚的表示常量与普通变量之间的区别。1.9、命名缩写在一般情况下，不推荐缩写命名，不要担心变量命名长，长的变量名能使变量的意义更加清晰，其实从长变量名的负面作用三，因为Ctrl+C和Ctrl+V加上在VS中的智能感知，其负面追用已经很小。变量命名的原则是，尽最大努力让其他人在看到我们的变量/函数/…等的第一时间，大概能猜