C#编码规范教程.docVIP

C#编码规范 重庆大学一六八软件有限公司 文档编号： 编写人：唐勇 编写日期：2014年12月29日 审核人： 审核日期： 审批人： 审批日期：  目录 第一章　概述 4 1.1 规范的重要性 4 1.2 规范制定原则 4 1.3 术语定义 4 Pascal 大小写 4 Camel 大小写 4 2.1 列宽 5 2.2 换行 5 2.3 缩进 5 2.4 空行 5 2.5 空格 5 2.6 花括号 - {} 6 3.1原则 7 3.2 注释概述 7 3.3 对于模块（类）的注释 7 3.4 代码间的注释 8 3.5 注释标签 9 第四章　申明 12 4.1每行声明数 12 4.2初始化 12 4.3位置 12 4.4字段的声明 13 第五章　命名规范 14 5.1命名概述 14 5.2大小写规则 14 5.3缩写 15 5.4命名空间 15 5.5 类 16 5.6接口 16 5.7属性 (Attribute) 17 5.8枚举 (Enum) 17 5.9参数 17 5.10方法 18 5.11属性 (property) 18 5.12事件 19 5.13常量 (const) 20 5.14字段 20 5.15静态字段 21 5.16集合 22 5.17措词 22 第六章　语句 24 6.1每行一个语句 24 6.2复合语句 24 6.3 return 语句 24 6.4 if、 if-else、if else-if 语句 24 6.5 for、foreach 语句 25 6.6 while 语句 25 6.7. do - while 语句 25 6.8. switch - case 语句 26 6.9 try - catch 语句 26 6.10 using 块语句 27 6.11 goto 语句 27 第七章 控件命名规则 28 7.1 命名方法 28 7.2 主要控件名简写对照表 28 第八章 其他 29 8.1 表达式 29 8.2 类型转换 29  第一章　概述 1.1 规范的重要性 增加开发过程中代码的强壮性、可读性、易维护性 减少有经验和无经验开发人员编码所需的脑力工作 为软件的良好维护性打下好的基础 在项目组内部易于代码层面的沟通 使新的开发人员快速的适应项目氛围 一个优秀而且职业化的开发团队所必须的素质 1.2 规范制定原则 1 方便代码的交流和维护。 2 不影响编码的效率，不与大众习惯冲突。 3 使代码更美观、阅读更方便。 4 使代码的逻辑更清晰、更易于理解。 1.3 术语定义 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如： BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor 第二章 代码外观 2.1 列宽 代码列宽控制在110字符左右。 2.2 换行 当表达式超出或即将超出规定的列宽，遵循以下规则进行换行 1、在逗号后换行。 2、在操作符前换行。 3、规则1优先于规则2。 当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。 2.3 缩进 缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。 Visual Studio.Net设置：工具-选项-文本编辑器-C#-制表符-插入空格 2.4 空行 空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。 在以下情况下使用两个空行 1、接口和类的定义之间。 2、枚举和类的定义之间。 3、类与类的定义之间。 在以下情况下使用一个空行 1、方法与方法、属性与属性之间。 2、方法中变量声明与语句之间。 3、方法与方法之间。 4、方法中不同的逻辑块之间。 5、方法中的返回语句与其他的语句之间。 6、属性与方法、属性与字段、方法与字段之间。 7、注释与它注释的语句间不空行，但与其他的语句间空一行。 2.5 空格 在以下情况中要使用到空格 1、关键字和左括符 “(” 应该用空格隔开。如 while (true) 注意：在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。多个参数用逗号隔开，每个逗号后都应加一个空格。 除了 . 之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如