C#编程规范近年原文.doc

C#编程规范

TOC\o1-3\h\z\u第一章概述 3

规范制定原则 3

术语定义 3

Pascal大小写 3

Camel大小写 3

文件注释 3

第二章代码外观 4

2.1 列宽 4

2.2 换行 4

2.3 缩进 4

2.4 空行 4

2.5 花括号-{} 4

第三章程序注释 4

3.1 文档型注释 4

3.2 类c注释 5

3.3 单行注释 5

第四章申明 5

4.1 每行声明数 5

4.2 初始化 6

4.3 位置 6

4.4 类和接口的声明 6

4.5 字段的声明 6

第五章命名规范 6

5.1 命名概述 6

5.2 大小写规则 7

5.3 命名空间 7

5.4 类 8

5.5 接口 8

5.6 属性(Attribute) 8

5.7 枚举(Enum) 9

5.8 参数 9

5.9 方法 9

5.10 属性(property) 9

5.11 事件 10

5.12 常量(const) 11

5.13 字段 11

5.14 静态字段 11

5.15 集合 11

第七章 控件命名规则 11

7.1 命名方法 11

7.2 主要控件名简写对照表 11

第八章 其他 12

8.1 表达式 12

8.2 类型转换 12

第一章概述

规范制定原则

1方便代码的交流和维护。

2不影响编码的效率，不与大众习惯冲突。

3使代码更美观、阅读更方便。

4使代码的逻辑更清晰、更易于理解。

术语定义

Pascal大小写

将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：

BackColor

Camel大小写

标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：

backColor

文件注释

1在每个文件头必须包含以下注释说明

/*

//Copyright(C)2010上海东兰信息技术有限公司

//版权所有。

//

//文件名：

//文件功能描述：

//

//

//创建标识：

//

//修改标识：

//修改描述：

//

//修改标识：

//修改描述：

//*/

文件功能描述只需简述，具体详情在类的注释中描述。

创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如：

李第二章代码外观

2.1 列宽

代码列宽控制在110字符左右。

2.2 换行

当表达式超出或即将超出规定的列宽，遵循以下规则进行换行

1、在逗号后换行。

2、在操作符前换行。

2.3 缩进

缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。

VisualStudio.Net设置：工具-选项-文本编辑器-C#-制表符-插入空格

2.4 空行

空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。

在以下情况下使用两个空行

1、接口和类的定义之间。

2、枚举和类的定义之间。

3、类与类的定义之间。

在以下情况下使用一个空行

1、方法与方法、属性与属性之间。

2、方法中变量声明与语句之间。

3、方法与方法之间。

4、方法中不同的逻辑块之间。

5、方法中的返回语句与其他的语句之间。

6、属性与方法、属性与字段、方法与字段之间。

7、注释与它注释的语句间不空行，但与其他的语句间空一行。

2.5 花括号-{}

while(1)

{

if(valid)

{