非常好的C#.NET-编程规范.docxVIP

C#编程规范

C#.NET编程规范

目录

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避免类型名称混淆 6

2.2.6命名空间命名指南 8

2.2.7类命名指南 9

2.2.8类成员变量命名指南 9

2.2.9接口命名指南 10

2.2.10属性命名指南 10

2.2.11枚举类型命名指南 10

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其它导向成功代码的因素 16

第1页

1

C#编程规范

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(用户编号必须输入！);}

第2页

2

C#编程规范

令为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或者注释在1024*800的

显示频率下不得超过一显示屏

令当一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清晰地表

示没有后面的行是不完整的。

令每一行上放置的语句避免超过一条。

令在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以使代码

容易阅读。

例：

intj=i+k;

而不应写为

intj=i+k;

令将大的复杂代码节分为较小的、易于理解的模块。

2.2命名指南

2.2.1大写样式

使用下面的三种大写标识符约定。

Pascal大小写

将标识符的首字母和后面连接的每一个单词的首字母都大写。可以对三字符或者更多字

符的标识符使用Pascal大小写。例如：

BackColor

Camel大小写

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

backColor

大写

标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如：

System.IO

System.Web.UI

可能还必须大写标识符以维持与现有非托管符号方案的兼容性，在该方案中所有大写字母时常用于枚举和常数值。普通情况下，在使用它们的程序集之外这些字符应当是不可见的。

第3页

3

C#编程规范

下表汇总了大写规则，并提供了不同类型的标识符的示例。

大小写标识符

大小写

类枚举类型

类

枚举类型枚举值事件

异常类

Pascal

Pascal

Pascal

Pascal

只读的静态字段接口

方法

命名空间

参数

属性

Pascal

Pascal

Pascal

Pascal

Camel

Pascal

受保护的实例字Camel

段

公共实例字段Pascal

示例

AppDomain

ErrorLevel

FatalError

ValueChange

WebException

注意总是以Exception后缀结尾。

RedValue

IDisposable

注意总是以I前缀开始。

ToString

System.Drawing

typeName

BackColor

redValue

注意很少使用。属性优于使用受保护的实例字段。

RedValue

注意很少使用。属性优于使用公共实例字段。

2.2.2区分大小写

为了避免混淆和保证跨语言交互操作，请遵循有关区分大小写的使用的下列规则：

令不要使用要求区分大小写的