OICS-01-02-NET程序编码规范v1.00.doc

运行管理系统项目 .NET程序编码规范 OICS-01-02--NET程序编码规范v1.00 微软(中国)有限公司顾问咨询部 2007年7月  修改日期 修改人 修改内容 2007-7-31 戴辉江 V1.00发布 目录 1. 概述 5 2. 命名规范 5 2.1 大写风格 5 2.1.1 Pascal风格 5 2.1.2 Camel风格 5 2.1.3 大写风格 5 2.1.4 大写小结 6 2.2 单词选择 6 2.2.1 缩写 7 2.3 命名空间 7 2.4 类和类成员 8 2.4.1 类的命名指南 8 2.4.2 Attribute命名指南 8 2.4.3 枚举命名指南 9 2.4.4 静态类属性名 9 2.4.5 参数名 9 2.4.6 方法命名指南 9 2.4.7 属性命名指南 9 2.4.8 事件命名指南 10 2.5 大小写敏感 10 3. 程序注释规范 11 3.1 模块注释 11 3.2 类的注释 12 3.3 类成员方法的注释 13 3.4 类成员属性、常量、变量的注释 14 3.5 程序注释 14 4. 类成员使用规范 14 4.1 属性使用指南 14 4.1.1 只读和只写的属性 17 4.2 事件使用指南 17 4.3 方法使用指南 18 4.3.1 方法重载指南 18 4.4 构建函数使用指南 19 4.5 类的成员变量使用指南 19 4.6 参数名称指南 21 5. 类型使用指南 21 5.1 类使用指南 22 5.1.1 基类使用指南 22 5.2 值类型使用指南 22 5.2.1 结构使用指南 22 5.2.2 枚举使用指南 23 5.3 程序代理使用指南 24 5.4 程序属性(Attribute)的使用 24 6. 异常的产生和处理 25 6.1 标准异常类型 27 6.2 异常的包装Wrapping Exceptions 28 7. 数组使用指南 29 7.1 数组vs. 集合 29 7.1.1 集合 29 7.1.2 集合中可索引的属性 29 7.1.3 数组值属性 29 7.2 返回空数组 29 8. 日志和跟踪使用指南 30 8.1 日志(Log)使用指南 30 8.2 跟踪(Tracing)使用指南 30  概述 在建设过程中，将涉及到在新的Visual Studio.NET以及.NET Framework平台上的开发工作。同时，设计人员、开发人员和测试人员较多。为了使应用程序的结构和编码风格标准化，便于阅读和理解编码好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。一组通用目的的编码约定应该定义完成上述目的所必需的、能让程序员自由地创建程序逻辑和功能流程的最小的要求。最小编码约定的目的是使程序易于阅读和理解，。命名 在命名指南中要注意三个要素 大小写: 使用正确的大小写风格. 技巧: 使用名词来命名类,动词来命名方法等等. 选择词汇: 在库中使用一致的短语 以下章节描述了大小写\技巧和一些词汇选择的原则. 大写风格 以下章节描述了不同方式的大写方式.这些术语将在通篇文档中被经常引用. Pascal风格 这种风格大写每个单词的首字母 BackColor 应在所有由多单词组成的公共描述符中使用这种方式.举例而言,使用TextColor就比 Textcolor或Text_color 注意不要大写 “连接词”（一个单词中包含了几个单词，但这个单词本身有自己的意思，如Checkbook）每个组合单词的首字母。应该将这个单词作为一个单词来考虑，而非几个单词的组合。使用词典决定一个组合词是不是应该作为一个单词来使用。 Camel风格 这种风格除了第一个单词的首字母,其他单词都应大写首字母,如下所示 backColor 在局部变量参数名或私有类属性名称上使用camel风格。 大写风格 只在少于两个字母的缩写中使用大写。三个以上字母的缩写都应该使用PASCAL风格。举例而言 System.IO System.Web.UI System.CodeDom 一个另外的情形是和原有的未管理的标志兼容，而原来常用大写来表示枚举和常量。通常这些标志符不应该暴露给外部。 大写小结 下表描述了不同类型的描述符该怎么使用大小写 类型 风格 备注 Class Pascal风格 ?? Enumeration value Pascal风格 ?? Enumeration type Pascal风格 ?? Event Pascal风格 ? Exception class Pascal风格 Exception. Read-only static field Pascal风格 ?