.net编码规范

2 声明

2.1每行声明数

一行只作一个声明，并按字母顺序排列。如

int level; //推荐 int size; //推荐 int x, y; //不推荐

2.2初始化

变量声明时初始化。

2.3位置

变量置于程序段的开始处，不必在第一次使用时声明。如 void MyMethod() {

int int1 = 0; // 方法开始

if (condition) {

int int2 = 0; // \"if\" 语句程序段开始 ... } }

不过也有一个例外

for (int i = 0; i < maxLoops; i++) { ... }

应避免不同层次间的变量重名，如

int count; ...

void MyMethod() {

if (condition) {

int count = 0; // ... } ...

}

2.4类和接口的声明

1 在方法名与其后的左括号间没有空格。

2 左花括号 “{” 出现在声明的下行并与之对齐，单独成行。 3 方法间用一个空行隔开。

2.5字段的声明

不使用 public 或 protected 实例字段。将字段直接公开给开发人员，可以更轻松地对类进行版本控制，原因在于维护二进制兼容性时字段不能被更改为属性。考虑为字段提供 get 和set 属性访问器，而不是使它们成为公共的。 get 和 set 属性访问器中的可执行代码使得后续改进成为可能，如在使用属性或者得到属性更改通知时根据需要创建对象。下面的代码示例阐释怎样正确使用带有get 和 set 属性访问器的私有实例字段。示例： public class Control: Component {

private int handle; public int Handle { get {

return handle; } }

}

3 命名规范

3.1 大小写规则

大写

仅对于由两个或者更少字母组成的标识符采用全部大写的形式。例如 System.IO

System.Web.UI

下表汇总了大写规则，并提供了不同类型的标识符的示例。 标识符 命名空间 类 方法 属性 公共实例字段 事件 枚举类型 枚举值 异常类 大小写 Pascal Pascal Pascal Pascal Pascal Pascal Pascal Pascal Pascal 示例 System.Drawing AppDomain ToString BackColor RedValue 注意 很少使用。属性优于使用公共实例字段。 ValueChange ErrorLevel FatalError WebException 异常总是以 Exception 后缀结尾。 只读的静态字段 Pascal 接口 Pascal RedValue IDisposable 接口总是以 I 前缀开始。 受保护的实例字段 Camel 私有的实例字段 Camel 参数 方法内的变量 Camel Camel redValue 很少使用。属性优于使用受保护的实例字段。 redValue typeName backColor 3.2 命名空间

1、命名命名空间时的一般性规则是使用公司名称，后跟技术名称和可选的功能与设计，如下所示。

CompanyName.TechnologyName[.Feature][.Design] 例如：

namespace Langchao.Procurement //浪潮公司的采购单管理系统 namespace Langchao.Procurement.DataRules //浪潮公司的采购单管理系统的业

务规则模块

2、命名空间使用Pascal大小写，用逗号分隔开。

3、TechnologyName 指的是该项目的英文缩写，或软件名。

4、命名空间和类不能使用同样的名字。例如，有一个类被命名为Debug后，就不要再使用Debug作为一个名称空间名。

3.3 类

1、使用 Pascal 大小写。 2、用名词或名词短语命名类。

3、使用全称尽量不要缩写，除非缩写已是一种公认的约定，如URL、HTML

4 、不要使用类型前缀，如在类名称上对类使用 C 前缀。例如，使用类名称 FileStream，而不是 CFileStream。

5 、不要使用下划线字符 (_)。

6 、有时候需要提供以字母 I 开始的类名称，虽然该类不是接口。只要 I 是作为类名称

组成部分的整个单词的第一个字母，这便是适当的。例如，类名称 IdentityStore 是适当的。在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException 对于从名为 Exception 的类派生的类是适当的名称，原因ApplicationException 是一种Exception。请在应用该规则时进行合理的判断。例如，Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件，但是将 Control 作为类名称的一部分将使名称不必要地加长。 public class FileStream public class Button

public class String

3.4 方法

以下规则概述方法的命名指南： 1 使用动词或动词短语命名方法。 2 使用 Pascal 大小写。 3 以下是正确命名的方法的实例。 RemoveAll() GetCharArray()

Invoke()

3.5 字段

以下规则概述字段的命名指南：

1、private、protected 使用 Camel 大小写。 2、public 使用 Pascal 大小写。

3、拼写出字段名称中使用的所有单词。仅在开发人员一般都能理解时使用缩写。字段名称不要使用大写字母。下面是正确命名的字段的示例。

class SampleClass {

string url;

string destinationUrl;

}

4、不要对字段名使用匈牙利语表示法。好的名称描述语义，而非类型。

5、不要对字段名或静态字段名应用前缀。具体说来，不要对字段名称应用前缀来

区分静态和非静态字段。例如，应用 g_ 或 s_ 前缀是不正确的。 6、对预定义对象实例使用公共静态只读字段。

3.6 静态字段

以下规则概述静态字段的命名指南： 1、使用 Pascal 大小写。

2、使用名词、名词短语或者名词的缩写命名静态字段。 3、对静态字段名称使用匈牙利语表示法前缀。 4、尽可能使用静态属性而不是公共静态字段。

3.7 属性 (Attribute)

将后缀 Attribute 添加到自定义属性类。以下是正确命名的属性类的示例。

public class ObsoleteAttribute {

}

3.8 属性 (property)

以下规则概述属性的命名指南： 1 使用名词或名词短语命名属性。 2 使用 Pascal 大小写。 3 不要使用匈牙利语表示法。

4 考虑用与属性的基础类型相同的名称创建属性。例如，如果声明名为 Color 的属性，则属性的类型同样应该是 Color。请参阅本主题中后面的示例。

以下代码示例阐释正确的属性命名。 public class SampleClass {

public Color BackColor {

// Get and Set的访问代码. } }

以下代码示例阐释提供其名称与类型相同的属性。 public enum Color {

// 枚举值 }

public class Control

{

public Color Color {

get {

//此处添加代码

} set

{

//此处添加代码

}

} }

以下代码示例不正确，原因是 Color 属性是 Integer 类型的。 public enum Color

{

//枚举值

}

public class Control {

public int Color {

//此处添加代码 } }

在不正确的示例中，不可能引用 Color 枚举的成员。Color.Xxx 将被解释为访问一个成员，该成员首先获取 Color 属性（ C# 中为 int 类型）的值，然后再访问该值的某个成员（该成 员必须是 System.Int32 的实例成员）。

3.9 参数

以下规则概述参数的命名指南：

1、使用描述性参数名称。参数名称应当具有足够的描述性，以便参数的名称及其类

型可用于在大多数情况下确定它的含义。

2、对参数名称使用 Camel 大小写。

3、 使用描述参数的含义的名称，而不要使用描述参数的类型的名称。开发工具将

提供有关参数的类型的有意义的信息。因此， 通过描述意义，可以更好地使用参数的名称。少用基于类型的参数名称，仅在适合使用它们的地方使用它们。

4、不要使用保留的参数。保留的参数是专用参数，如果需要，可以在未来的版本中

公开它们。相反，如果在类库的未来版本中需要更多的数据，请为方法添加新的重载。

5、不要给参数名称加匈牙利语类型表示法的前缀。

以下是正确命名的参数的示例。 Type GetType(string typeName)

string Format(string format, args() As object)

3.10 事件

以下规则概述事件的命名指南：

1、对事件处理程序名称使用 EventHandler 后缀。

2、指定两个名为 sender 和 e 的参数。sender 参数表示引发事件的对象。sender 参数始终是object 类型的，即使在可以使用更为特定的类型时也如此。与事件相关联的状态封装在名为 e 的事件类的实例中。对 e 参数类型使用适当而特定的事件类。

3、用 EventArgs 后缀命名事件参数类。 4、考虑用动词命名事件。

5、使用动名词（动词的“ing”形式）创建表示事件前的概念的事件名称，用过去式表示事件后。例如，可以取消的 Close 事件应当具有 Closing 事件和 Closed 事件。不要使用BeforeXxx/AfterXxx 命名模式。

6、不要在类型的事件声明上使用前缀或者后缀。例如，使用 Close，而不要使用 OnClose。 7、通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法（称为 OnXxx）。此方法只应具有事件参数 e，因为发送方是类型的实例。 以下示例阐释具有适当名称和参数的事件处理程序。

public delegate void MouseEventHandler(object sender, MouseEventArgs e);

以下示例阐释正确命名的事件参数类。

public class MouseEventArgs : EventArgs {

int x;

int y;

public MouseEventArgs(int x, int y) {

this.x = x; this.y = y; }

public int X { get {

return x; } }

public int Y {

get

{

return y; } } }

3.11 接口

以下规则概述接口的命名指南：

1、用名词或名词短语，或者描述行为的形容词命名接口。例如，接口名称 IComponent 使

用描述性名词。接口名称 ICustomAttributeProvider 使用名词短语。名称 IPersistable 使用形容词。 2、使用 Pascal 大小写。

3、少用缩写。

4、给接口名称加上字母 I 前缀，以指示该类型为接口。在定义类/接口对（其中类是接

口的标准实现）时使用相似的名称。两个名称的区别应该只是接口名称上有字母 I 前缀。

5、不要使用下划线字符 (_)。

6、当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处,只是接口名前有一个I前缀。

以下是正确命名的接口的示例。

public interface IServiceProvider public interface IFormatable

以下代码示例阐释如何定义 IComponent 接口及其标准实现 Component 类。 public interface IComponent {

// 代码实现. }

public class Component: IComponent {

//代码实现.

}

3.12 常量 (const)

以下规则概述常量的命名指南：

所有单词大写，多个单词之间用 \"_\" 隔开。 如

public const string PAGE_TITLE = \"Welcome\";

对象本身的公共静态只读字段。使用 Pascal 大小写，原因是字段是公共的。下面的代码

示例阐释公共静态只读字段的正确使用。

public struct Color {

public static readonly Color Red = new Color(0x0000FF); public Color(int rgb)

{

//此处添加代码}

public Color(byte r, byte g, byte b) {

//此处添加代码

}

public byte RedValue { get {

return Color; } } }

3.13 枚举 (Enum)

枚举 (Enum) 值类型从 Enum 类继承。以下规则概述枚举的命名指南： 1 对于 Enum 类型和值名称使用 Pascal 大小写。 2 少用缩写。

3 不要在 Enum 类型名称上使用 Enum 后缀。

4 对大多数 Enum 类型使用单数名称，但是对作为位域的 Enum 类型使用复数名称。 5将 FlagsAttribute 添加到位域 Enum 类型。

3.14 集合

集合是一组组合在一起的类似的类型化对象，如哈希表、查询、堆栈、字典和列表，集合命名用复数。

3.15 缩写

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

1 不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用 GetWindow，而不要使

用 GetWin。

2 不要使用计算机领域中未被普遍接受的缩写。

3 在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用 UI 作为 User Interface 缩写，用 OLAP 作为 On-line Analytical Processing 的缩写。 4在使用缩写时，对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。例如，使用 HtmlButton 或 HTMLButton。但是，应当大写仅有两个字符的缩写，如，System.IO，而不是 System.Io。

5 不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请使用Camel 大小写，虽然这和单词的标准缩写相冲突。

4 行长度

行长度以在编辑器中不用拖动滚动条能看全一行代码即可。

5 函数长度

单个函数的长度不应该超过100行代码，如果超过一百行代码则需简化代码或利用Extract Method重构手法，将其中过于复杂的代码段抽取为一个的方法，然后替换原代码段。

6 判断语句

如果一个判断语句的表达式较长（比如有多个条件项），不能很快看明白此判断语句的意图，则需要将此判断语句抽取为一个的方法，用一个能反映判断意图的名称给方法命名，然后将此判断语句中的表达式替换为抽取所得的方法名称。

7 语句

7.1 每行一个语句

每行最多包含一个语句。如 a++; //推荐 b--; //推荐

a++; b--; //不推荐

7.2 复合语句

复合语句是指包含\"父语句{子语句;子语句;}\"的语句，使用复合语句应遵循以下几点

1 子语句要缩进。

2 左花括号“{” 在复合语句父语句的下一行并与之对齐，单独成行。

7.3 if、 if-else、if else-if 语句

if、 if-else、if else-if 语句使用格式 if (条件) {

语句体; }

if (条件) {

语句体; } else {

语句体; }

if (条件) {

语句体; }

else if (条件) {

语句体; } else {

语句体; }

7.4 for、foreach 语句

for 语句使用格式

for (初始化 ; 循环条件; 步长更新) {

语句体; }

空的 for 语句（所有的操作都在初始化、循环条件或步长更新中实现）使用格式 for (初始化 ; 循环条件; 循环计数器更新); // 更新用户id foreach 语句使用格式

foreach (object obj in array) {

语句体;

}

注意 1在循环过程中不要修改循环计数器。 2对每个空循环体给出确认性注释。

7.5 while 语句

while 语句使用格式 while (条件) {

语句体; }

空的 while 语句使用格式 while (条件);

7.6 do - while 语句

do - while 语句使用格式 do {

语句体;

} while (条件);

7.7 switch - case 语句

switch - case 语句使用格式 switch (条件) {

case 1: 语句体; break; case 2: 语句体;

break; default: 语句体; break; } 注意：

1、语句switch中的每个case各占一行。 2、语句switch中的case按字母顺序排列。 3、为所有switch语句提供default分支。

4、所有的非空 case 语句必须用 break; 语句结束。

7.8 try - catch 语句

try - catch 语句使用格式 try {

语句体; }

catch (ExceptionClass e) {

语句体; } finally {

语句体; }

7.9 return 语句

return语句中不使用括号，除非它能使返回值更加清晰。如 return;

return myDisk.size();

return (size ? size : defaultSize);

7.10 using语句

using语句使用格式 using (object) {

语句体; }

7.11 goto 语句

goto 语句使用格式

goto Label1:

语句体; Lable1: 语句体;

8 空白

8.1 空行

逻辑相关的代码段用空行分隔开，以提高代码可读性。下列情况最好使用两个空行： （1） 一个源文件的两个片段(section)之间。 （2） 类声明和接口声明之间。 下列情况最好使用一个空行： （1） 两个方法之间。

（2） 方法内的局部变量和方法的第一条语句之间。 （3） 程序段注释或单行注释之前。

（4） 一个方法内的两个逻辑段之间，用以提高可读性。

8.2 空格

在下列情况使用空格：

（1） 一个紧跟着括号的关键字要用空格分隔，例如： while (true) { ... }

注意：空格不应该置于方法名与其左括号之间。这将有助于区分关键字和方法调用。 （2） 空白应该位于参数列表中逗号的后面。

（3） 所有的二元运算符，除了\".\"，应该使用空格将之与操作数分开。一元操作符和操

作数之间不需要加空格，比如：负号(\"-\")、自增(\"++\")和自减(\"--\")。例如：

a += c + d;

a = (a + b) / (c * d);

while (d++ = s++) { n++; }

printSize(\"size is \" + foo + \"\\n\"); （4） for语句中的表达式要用空格分开，例如：

for (expr1; expr2; expr3)

（5） 强制类型转换后添加一个空格，例如： myMethod((byte) aNum, (Object) x);

myMethod((int) (cp + 5), ((int) (i + 3)) + 1);

9 缩进

代码没有缩进是很难读懂的，代码以１个tab键或4个空格缩进。Visual Studio.Net设置：工具->选项->文本编辑器->C#->制表符->插入空格

10 控件命名规则

10.1 命名方法

控件名缩写+英文描述，英文描述首字母大写

10.2 主要控件名缩写对照表

控件名 TextBox LinkButton DropDownList DataGrid CheckBox RadioButton Image Calender Table CompareValidator CrystalReportViewer 缩写 txt lnkbtn ddl dg chk rdo img cld tbl cv rptvew 控件名 Label Button ImageButton ListBox DataList CheckBoxList RadioButtonList Panel AdRotator RangeValidator ValidatorSummary 缩写 lbl btn imgbtn lst dl chkls rdolt pnl ar rv vs RequiredFieldValidator rfv RegularExpressionValidator rev 11 其他

11.1 表达式

（1） 尽量不要在表达式中用赋值语句。

（2） 尽量不要对浮点类型做等于或不等于的判断。

11.2 类型转换

（1） 尽量不要强制类型转换。

（2） 如果不得不做类型转换，尽量用显式方式。