很全的C开发编码规范.docVIP

C#编程规范 目录 1前言 2 1.1 编写目的 2 1.2 范围 2 2. 规范内容 2 2.1 代码格式 2 2.2 命名指南 3 2.2.1 大写样式 3 2.2.2 区分大小写 4 2.2.3 缩写 5 2.2.4 措词 5 2.2.5 避免类型名称混淆 7 2.2.6 命名空间命名指南 8 2.2.7 类命名指南 9 2.2.8 类成员变量命名指南 10 2.2.9 接口命名指南 10 2.2.10 属性命名指南 10 2.2.11 枚举类型命名指南 11 2.2.12 静态字段命名指南 11 2.2.13 参数命名指南 11 2.2.14 方法命名指南 12 2.2.15 属性命名指南 12 2.2.16事件命名指南 13 2.3??? 注释（Comment）规范 14 2.3.1 模块（类）注释规范 14 2.3.2 类属性注释规范 15 2.3.3 方法注释规范 15 2.3.4 代码间注释规范 15 3 成功的模式 16 3.1 有效地使用这些标准 16 3.2 其它导向成功代码的因素 17  1前言 1.1 编写目的 为了保证企业编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 1.2 范围 适用于企业所有基于.NET平台的软件开发工作。 2. 规范内容 2.1 代码格式 所有的缩进为4个空格，使用VS.NET的默认设置。 在代码中垂直对齐左括号和右括号。 if(x==0) { Response.Write(用户编号必须输入！); } 不允许以下情况： if(x==0) { Response.Write(用户编号必须输入！); } 或者： if(x==0){ Response.Write(用户编号必须输入！);} ? 为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在1024*800的显示频率下不得超过一显示屏 当一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。 每一行上放置的语句避免超过一条。 在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以使代码容易阅读。 例： int j = i + k; 而不应写为 int j=i+k; 将大的复杂代码节分为较小的、易于理解的模块。 2.2 命名指南 2.2.1 大写样式 使用下面的三种大写标识符约定。 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如： BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor 大写 标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如： System.IO System.Web.UI 可能还必须大写标识符以维持与现有非托管符号方案的兼容性，在该方案中所有大写字母经常用于枚举和常数值。一般情况下，在使用它们的程序集之外这些字符应当是不可见的。 下表汇总了大写规则，并提供了不同类型的标识符的示例。 标识符 大小写 示例 类 Pascal AppDomain 枚举类型 Pascal ErrorLevel 枚举值 Pascal FatalError 事件 Pascal ValueChange 异常类 Pascal WebException 注意 总是以 Exception 后缀结尾。 只读的静态字段 Pascal RedValue 接口 Pascal IDisposable 注意 总是以 I 前缀开始。 方法 Pascal ToString 命名空间 Pascal System.Drawing 参数 Camel typeName 属性 Pascal BackColor 受保护的实例字段 Camel redValue 注意 很少使用。属性优于使用受保护的实例字段。 公共实例字段 Pascal RedValue 注意 很少使用。属性优于使用公共实例字段。 为了避免混淆和保证跨语言交互操作，请遵循有关区分大小写的使用的下列规则： 不要使用要求区分大小写的名称。对于区分大小写和不区分大小写的语言，组件都必须完全可以使用。不区分大小写的语言无法区分同一上下文中仅大小写不同的两个名称。因此，在创建的组件或类中必须避免这种情况。 不要创建仅是名称大小写有区别的两个命名空间。例如，不区分大小写的语言无法区分以下两个命名空间声明。 namespace ee.cummings; namespace Ee.Cummings;不要创建具有仅是大小写有区别的参数名称的函数