C#编码规范 文档版本 V0.01 1. 目的 规范C#代码的书写,提高代码的可读性,使开发人员在代码上更好的协作,减少新开发成员熟悉现有代码的时间,间接提高软件代码的可维护性。 2. 命名规范 1) 命名约定 标识符构成: 所有标识符应由一个或多个完整的英文单词构成,除通用的缩略词如IO、Http、id 等或是项目特定的专用缩略词如项目名称的缩写等,不应使用未被普遍接受的单词缩略形式。可以适当使用下划线“_”。 2) 大小写约定 Pascal : 组成标识符的所有单词的首字母大写,如Get、BackColor。 Camel : 组成标识符的第一个单词全小写,后续单词首字母大小,如get、backColor。 全大写:组成标识符的所有单词的所有字母全部大写。 缩略词 : ➢ 不要使用半个单词的缩写形式,如GetWin,而应使用GetWindow。 ➢ 不要使用不被普遍认可的首字母缩写。在适当情况下,使用通用的首字母缩写,如UI 表示 User interface,而 OLAP 表示 On-line Analytical Processing。两个字母的缩写单独使用时可以适当使用全大写书写风格替代Pascal 风格。 ➢ 不要在标识符或参数名中使用首字母缩写,必须使用时,应使用Camel 形式。 ➢ Id 不是首字母缩写,不应使用全大写方式。 3) C#命名规范 以.Net 公共语言规范(CLSCompliant)为基础,规定标识符的命名规则。 标识符类别 大小写约定 示例 命名空间 Pascal System; System.Web; 委托、枚举、结构、类名 Pascal(对于特殊类型,应使用特定后缀,参见附录 I) Page; UserControl; DateTime; DateTimeKind; EventHandler; 接口 Pascal, 并带有前缀 I IDisposable; IHttpHandler; 枚举成员 Pascal Error; FatalError; 属性、方法、事件 Pascal BackColor; GetBackColor; BackColorChanged; 方法、属性参数声明 Camel backColor; name; userId 泛型参数声明 Pascal,T 或带有前缀T T; TResult; TKey; TValue; 私有字段 Camel,推荐使用下划线前缀,以区别于局部变量。对于控件变量,应使用对应的控件类型缩写。对 于 静 态 私 有字 段 , 使 用 g_ 前 缀 。与属性对 应的私 有 字 段 使 用 属性名前 加下划线。 _backColor; _userId; txtUsername; txtPassword; s_instance;_UserName; 保护字段 禁止使用。 私有常量 Pascal(包括私有静态只读字段)。 公共常量 Pascal(包括公共静态只读字...