CSharp编码规范.doc

目 录 第1章 概述 3 1.1 前言 3 1.2 规范制定原则 3 1.3 术语定义 3 1.3.1 Pascal 大小写 3 1.3.2 Camel 大小写 3 1.4 文件命名组织 3 1.4.1 文件命名 3 1.4.2 文件使用注意 4 第2章 代码外观 5 2.1 列宽 5 2.2 换行 5 2.3 缩进 5 2.4 空格、括号 - ()、 花括号 - {} 5 第3章 申明 6 3.1 每行声明数 6 3.2 初始化 6 3.3 位置 6 3.4 类和接口的声明 8 3.5 字段的声明 8 第4章 命名规范 9 4.1 命名概述 9 4.2 大小写规则 10 4.3 缩写 11 4.4 命名空间 11 4.5 类 11 4.6 接口 12 4.7 属性 (Attribute) 13 4.8 参数 13 4.9 方法 14 4.10 属性 (property) 14 4.11 常量 (const) 15 4.12 字段 15 第5章 第六章　语句 17 5.1 每行一个语句 17 5.2 复合语句 17 5.3 return 语句 17 5.4 if、 if-else、if else-if 语句 18 5.5 for、foreach 语句 19 5.6 while 语句 19 5.7 do - while 语句 19 5.8 switch - case 语句 20 5.9 try - catch 语句 20 第6章 控件命名规则 22 6.1 命名方法 22 6.2 主要控件名简写对照表 22 概述 前言 为统一公司开发人员的编码规范，使程序具有良好的可读性，方便代码的交流和维护，特制定如下编码规定，公司全体开发人员需严格遵循本规范进行编码。 规范制定原则 1 方便代码的交流和维护。 2 不影响编码的效率，不与大众习惯冲突。 3 使代码更美观、阅读更方便。 4 使代码的逻辑更清晰、更易于理解。 术语定义 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。 例如：BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。 例如： backColor 文件命名组织 文件命名 1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。 2 使用统一而又通用的文件扩展名： C# 类.cs 文件使用注意 1.? 避免将多个类放在一个文件里面。 2.? 一个文件应该只有一个命名空间，避免将多个命名空间放在同一个文件里面。 3.? 一个文件代码一般控制在300-400行，最好不要超过500行（不包括机器产生的代码）。 代码外观 列宽 代码列宽控制在110字符左右。 换行 当表达式超出或即将超出规定的列宽，遵循以下规则进行换行 1、在逗号后换行。 2、在操作符前换行。 3、规则1优先于规则2。 当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。 缩进 缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。 Visual Studio.Net设置：工具-选项-文本编辑器-C#-制表符-插入空格 空格、括号 - ()、 花括号 - {} 以VS2005默认值为标准。在完成代码后，将最后出现的“}”删除再输入，VS2005系统将自动调整。 申明 每行声明数 一行只建议作一个声明，并按字母顺序排列。如 int level; //推荐 int size; //推荐 int x, y; //不推荐 初始化 建议在变量声明时就对其做初始化。 位置 变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。如 类和接口的声明 1 在方法名与其后的左括号间没有任何空格。 2 左花括号 “{” 出现在声明的下行并与之对齐，单独成行。 3 方法间用一个空行隔开。 字段的声明 不要使用是 public 或 protected 的实例字段。考虑为字段提供 get 和set 属性访问器，而不是使它们成为公共的。示例： 命名规范 命名概述 使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读避免容易被主观解释的难懂的名称，如 AnalyzeThis()，或者 xxK8。这样的名称会导致多义性。在类属性的名称中包含类名是多余的，如 Book.BookTitle。而是应该使用 Book.Title。只要合适，在变量名的末尾加计算限定符（Avg、Sum、Min、Max、Index）。在变量名中使用互补对，如 min/max