NET(C#)编码规范.doc

.NET(C#)编码规范 软件开发中心技术总监室 2010年2月目录 第1章 命名规范 4 1.1 大小写风格 4 1.1.1 Pascal风格 4 1.1.2 Camel风格 4 1.1.3 缩写风格 4 1.1.4 大小写风格选择 5 1.2 词汇选择 5 1.3 命名空间命名规范 5 1.4 代码文件命名规范 6 1.5 程序集命名规范 6 1.6 类、枚举和接口命名规范 6 1.6.1 类的命名规范 6 1.6.2 属性类(Attribute)命名规范 6 1.6.3 接口命名规范 6 1.6.4 枚举命名规范 6 1.7 类成员命名规范 7 1.7.1 方法命名规范 7 1.7.2 字段命名规范 7 1.7.3 参数命名规范 7 1.7.4 属性命名规范 8 1.7.5 泛型命名规范 8 1.7.6 事件命名规范 8 1.7.7 资源命名规范 9 第2章 换行、空格和大括号的使用规范 9 2.1 换行 9 2.2 空格 10 2.3 大括号 10 第3章 程序注释规范 11 3.1 添加版权信息 11 3.2 模块注释 11 3.3 类的注释 11 3.4 类成员方法的注释 12 3.5 类成员属性、常量、变量的注释 12 3.6 程序注释 12 3.7 使用region分组 13 第4章 类型使用规范 13 4.1 引用类型和值类型的选择 13 4.2 类和接口的选择 13 4.3 类使用规范 13 4.3.1 静态类使用规范 13 4.3.2 抽象类使用规范 14 4.4 接口使用规范 14 4.5 值类型使用规范 14 4.5.1 结构使用规范 14 4.5.2 枚举使用规范 14 4.6 事件使用规范 15 4.7 属性类(Attribute)使用规范 15 第5章 类成员使用规范 16 5.1 属性使用规范 16 5.1.1 只读和只写属性 16 5.2 方法使用规范 16 5.2.1 方法重载规范 16 5.3 构造方法使用规范 17 5.4 字段使用规范 17 5.5 参数使用规范 18 第6章 异常的产生和处理 18 6.1 异常使用规范 18 6.2 异常创建规范 19 6.3 异常捕获规范 20 6.4 标准异常类型 20 第7章 其它 20 7.1 循环使用规范 20 7.2 switch使用规范 21 7.3 数组 vs 集合 21 7.4 string vs StringBuilder 21 7.5 非托管资源的使用 21  引言 良好的编程规范不仅可增强代码的可读性，便于阅读和理解，提高团队合作效率，还可以使代码结构优化、严谨，从而改善软件质量。但由于软件开发中心引入.NET技术的时间不长，相关的编程语言规范基本处于空白阶段。本文为.NET体系中最常用的C#语言整理了一套较为完整的编程规范，内容包括命名、风格、类型、类的成员、异常、数组等多个方面。本规范是C#程序员的编程准则，也是项目团队独自制定编程规范的基础依据。 随着.NET技术在软件开发中心应用的深入和经验积累，本规范也将随之完善或补充。由于时间紧张、编者经验不足等缘故，本规范难免存在纰漏，恳请广大读者予以批评指正。 命名 命名 大小写: 使用的大小写风格 技巧: 使用名词命名类,动词命名方法等 词汇: 使用一致的短语 以下章节描述了大小写技巧和一些词汇选择的原则 大写风格 Pascal风格 Pascal风格：包含一到多个单词，每个单词第一个字母大写，其余字母均小写。 TextColor 应在由多单词组成的公共描述符中使用方式TextColor是Pascal风格， Textcolor和Text_color不是Pascal风格。注意不要大写 “”（一个单词中包含了几个单词，，如）每个组合单词的首字母。应该将这个单词作为一个单词来考虑，而非几个单词的组合。使用词典决定一个组合词是不是应该作为一个单词来使用。 Camel风格 Camel风格包含一到多个单词，第一个单词首字母小写，其余单词首字母大写，其他字母均小写。如 textColor 缩写风格 在少于两个字母的缩写中使用大写三个以上字母缩写使用P风格。 大小写风格选择 下表描述了不同类型的描述符该怎么使用大小写 类型 风格 Pascal风格 Pascal风格 Pascal风格 Pascal风格 Pascal风格 Pascal风格 Pascal风格 Pascal风格 Pascal风格 Camel风格 Camel风格 词汇选择 不要使用常用的命名空间名名 不要使用公共语言规范（CLS）中的关键字作类名。 不要抽取的部分作为名称使用。如使用Get比Get更好 必要时请使用广为人知的缩写。 用UI表示User Interface，用OLA