1 / 13
文档名称:

C#命名规范.doc

格式:doc   页数:13页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

C#命名规范.doc

上传人:xxj16588 2016/5/31 文件大小:0 KB

下载得到文件列表

C#命名规范.doc

文档介绍

文档介绍:C# 命名规范对 C#.NET 编程规范的个人见解对 C#.NET 编程规范的个人见解作者: Eunge 邮箱: @ 我们应该知道编程规范对于项目的生命周期多么重要, 如果每个程序员写的代码都令其他人难以阅读、或者一个团队项目的代码却五花八门,这样的项目将会是怎么样的噩梦。 MS 为提供了 FXCop 工具,用于自动检查代码的规范性、安全性和效率,所以,本文将围绕 MS 提供的 C#.NET 代码规范展开。 FXCop 工具下载地址: m/fxcop 1 、命名约定 Pascal 和 Camel 命名约定编程的命名方式主要有 Pascal 和 Camel 两种( Pascal :每个单词的首字母大写,例如 ProductType ; Camel :首个单词的首字母小写, 其余单词的首字母大写,例如 productType ) 以下是一些常用的 C# 成员及其推荐命名方法: 标志符规则实例与描述类 class Pascal Application 枚举类型 enum Pascal 记住, 是以 Pascal 命名, 切勿包含 Enum , 否则 FXCop 会抛出 Issue 委托 delegate Pascal 以 Pascal 命名,不以任何特殊字符串区别于类名、函数名常量 const 全部大写全部大写,单词间以下划线隔开接口 interface Pascal IDisposable 注:总是以 I 前缀开始,后接 Pascal 命名方法 function Pascal ToString 命名空间 namespace Pascal 以. 分隔,当每一个限定词均为 Pascal 命名方式,比如: using 参数 Camel 首字母小写局部变量 Camel 也可以加入类型标识符,比如对于 类型,声明变量是以 str 开头, string strSQL = ; 数据成员 Camel 以m 开头+ Pascal 命名规则,如 mProductType (m 意味 member ) 属性 Pascal 、局部变量命名在 primitive 的局部变量命名时,使用 Camel 命名规则, 比如: int type = 0; double count = 0; …对于 string 类型定义,通常使用 str 前缀+ Pascal 命名的方式, 比如 string strSql = ""; // 这是一种典型的命名 SQL 语句字符串的方式。而对于此外的类型对象定义,通常的做法是使用 obj 前缀+ Pasca l 命名的方式, 来告知我们这个变量是一个对象。或者也可以直接使用类名的 Camel 命名规则。比如: Application objApplication = new Application(); Application application = new Application(); 、参数命名 Camel 命名规则,首字母小写 、类数据成员/ 属性命名数据成员命名以 Camel 命名方式,而属性以 Pascal 命名。通常如果数据成员与属性成对的话, 数据成员与属性的命名区别仅在于变量名的第一个字母是小写还是大写。比如 class Appcalition { private ArrayList worksheetCollection = new ArrayList(); public ArrayList WorksheetCollection { get { return ; }}} 另外,类的成员数据/ 方法调用时,应该加上 this 限定符, this 在编辑环境中是蓝色的,更利于我们区分局部变量、参数或静态变量, 并且利于 FXCop 检测区分。(如果使用 FxCop 扫描和检测代码的话) 、命名空间命名在 dot 之间的各限定字符串符合 Pascal 格式 、委托缩写委托的命名方式我常常以 Pascal 命名,并且在命名的后面加 EventHandler 比如 public delegate void MouseEventHandler (object sender, MouseEventArgs e); // 用于处理与鼠标相关的事件或委托对于自定义的委托,其参数第一个建议仍然使用 object sender , sender 代表触发这个时间或委托的源对象。而第二个参数继承于 EventArgs 类,并且在派生类中实现自己的业务逻辑。 、自定义异常类自定义异常类以 Exception 结尾, 并且在类名中能清楚的描述出该