CSharp代码编写指导规范.docVIP

项目： 规范 文号： COD-STA-01 版本： V1.0 编写人： Antony 时间： 2005-11-4 C#代码编写指导规范 版本变更记录： 时间 版本 作者/修改人 修改原因 2005-11-4 V1.0 Antony 正式发布 目 录 1 简介 3 1.1 目标 3 1.2 范围 3 1.3 基本依据 3 1.4 标记约定 3 1.5 术语和缩略语 3 1.6 参考 3 2 通用规则 3 3 命名约定 3 3.1 一般规则 3 3.2 命名空间命名 4 3.3 类及结构命名 4 3.4 接口命名 5 3.5 枚举命名 5 3.6 事件命名 5 3.7 控件命名 5 4 注释和内嵌文档 6 4.1 文件头部 6 4.2 使用#region 标注一组相关的非公共成员 7 4.3 类的注释 7 4.4 类属性注释规范 7 4.5 方法注释规范 7 4.6 代码间注释规范 7 5 声明 8 5.1 每行的声明数 8 5.2 初始化 8 5.3 类和接口的声明 8 6 表达式 9 6.1 简单表达式 9 6.2 return语句 9 6.3 if, if-else, if else-if else 语句 9 6.4 for, foreach 语句 10 6.5 while, do-while语句 10 6.6 switch 语句 11 6.7 try-catch 语句 11 7 留白 11 7.1 空行 11 7.2 空格 12 8 编码准则 12 8.1 可见性 12 8.2 Magic Number 12 8.3 异常处理 12 8.4 其他 12 9 代码示例 13 9.1 括号的位置示例 13 9.2 变量命名示例 13 10 编码风格 14 1 简介 1.1 目标 本主题提供命名指南.NET?Framework?常规参考Recommendations建议:正常情况下优先考虑，如果有违反建议的编码，应该同有经验的同事商量并取得违反建议的理由共识后才能实施，推荐对违反建议的代码进行注解。 1.5 术语和缩略语 1.6 参考 MSDN-命名指南 Coding Standard: C# - philips 2 通用规则 （1）每一次不能执行建议的编码规则，必须要有合理的理由，理由不包括个人的编码风格因素。 （2）在一个文件中不要混合不同所有者的代码，因为第三方的代码可能不会遵守相同的编码规范。 3 命名约定 3.1 一般规则 （1）使用 US-English 作为命名标识符依据。 （2）使用命名标识符的 Pascal 大小写、Camel 大小写IDENTIFIER CASE EXAMPLE Class Pascal AppDomain Enum type Pascal ErrorLevel Enum values Pascal FatalError Event Pascal ValueChange Exception class Pascal WebException Field camel listItem Const Field camel maximumItems Read-only Static Field camel redValue Interface Pascal IDisposable Method Pascal ToString Namespace Pascal System.Drawing Parameter camel typeName Property Pascal BackColor DENTIFIER CASE EXAMPLE （4）在标识符名称中不再使用Hungarian 符号法以及其他附加类型表示法。 （5）不要给名称加匈牙利语类型表示法的前缀。void calculate() void Calculate() （7）不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用 GetWindow，而不要使用 GetWin。在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用 UI 作为 User Interface 的缩写，用 OLAP 作为 On-line Analytical Processing 的缩写。标识符名称使用描述标识符含义的名称，而不要使用描述标识符类型的