#C#编程规范

作者:胡飞玲时间： 2020-10-16

普通的工程师堆砌代码，优秀的工程师优雅代码，卓越的工程师简化代码

推荐书籍：《代码整洁之道》、《编写可读代码的艺术》、《重构:改善既有代码的设计》

C#编程规范

Version 1.0

# 第一章　概述

# 术语定义

# Pascal 大小写（大驼峰）

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

BackColor

适用范围：项目名称，命名空间、类型名称

# Camel 大小写（小驼峰）

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

backColor

适用范围：控件，函数参数，类私有、保护的字段

# 第二章代码标准

规定一：【避免在程序中使用魔鬼数字，必须用有意义的常量来标识。】

说明：是否是魔鬼数字要基于容易阅读和便于全局替换的原则。0、1 作为某种专业领域物理量枚举数值时必须定义常量，严禁出现类似 NUMBER_ZERO 的“魔鬼常量”。

规定二：【明确方法的功能，一个方法仅完成一个功能。】

说明：方法功能太多，会增加方法的复杂度和依赖关系，不利于程序阅读和将来的持续维护，无论是方法还是类设计都应符合单一职责原则。

规定三：【方法参数不能超过 5 个】

说明：参数太多影响代码阅读和使用，为减少参数，首先要考虑这些参数的合理性，保持方法功能单一、优化方法设计，如果参数确实无法减少，可以将多个参数封装成一个类（对象），同时考虑在新的类（对象）中增加相应的行为，以期更符合 OOP。

规定四：【方法调用尽量不要返回 null，取而代之以抛出异常，或是返回特例对象（SPECIAL CASE object，SPECIAL CASE PATTERN）；对于以集合或数组类型作为返回值的方法，取而代之以空集合或 0 长度数组。】

说明：返回 null 会增加不必要的空指针判断，遗漏判断也会导致严重的 NullPointerException 错误。

规定五：【在进行数据库操作或 IO 操作时，必须确保资源在使用完毕后得到释放，并且必须确保释放操作在 finally 中进行。】

说明：数据库操作、IO 操作等需要关闭对象必须在 try -catch-finally 的 finally 中 close()，如果有多个 IO 对象需要关闭，需要分别对每个对象的 close()方法进行 try-catch,防止一个 IO 对象关闭失败其他 IO 对象都未关闭。推荐做法如下：

规定六：【异常捕获不要直接 catch(Exception ex) ，应该把异常细分处理。】

说明：catch (Exception ex)的结果会把 RuntimeException 异常捕获，RuntimeException 是运行期异常，是程序本身考虑不周而抛出的异常，是程序的 BUG，如无效参数、数组越界、被零除等，程序必须确保不能抛出 RuntimeException 异常，不允许显示捕获 RuntimeException 异常就是为了方便测试中容易发现程序问题。

规定七：【对于 if „ else if „(后续可能有多个 elseif …)这种类型的条件判断，最后必须包含一个 else 分支，避免出现分支遗漏造成错误；每个 switch-case 语句都必须保证有 default，避免出现分支遗漏，造成错误。】

规定八：【覆写对象的 equals()方法时必须同时覆写 hashCode()方法。】

说明：equals 和 hashCode 方法是对象在 hash 容器内高效工作的基础，正确的覆写这两个方法才能保证在 hash 容器内查找对象的正确性，同时一个好的 hashCode 方法能大幅提升 hash 容器效率。

规定九：【禁止循环中创建新线程，尽量使用线程池。】

规定十：【在进行精确计算时(例如:货币计算)避免使用 float 和 double，浮点数计算都是不精确的，必须使用 BigDecimal 或将浮点数运算转换为整型运算。】

说明：浮点运算在一个范围很广的值域上提供了很好的近似，但是它不能产生精确的结果。二进制浮点对于精度计算是非常不适合的，因为它不可能将 0.1——或者 10 的其它任何次负幂精确表示为一个长度有限的二进制小数。

# 第三章代码外观

# 2.1 缩进

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

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

# 2.2 空格

在以下情况中要使用到空格

1、关键字和左括符 “(” 应该用空格隔开。如

 while (true)

**注意**在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。

2、多个参数用逗号隔开，每个逗号后都应加一个空格。

3、除了 . 之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如

  a += c + d;
  a = (a  + b)  /  (c * d);
        while (d++ = s++)
        {
          n++;
        }
  PrintSize(“size is “ + size + “\n”);

1
2
3
4
5
6
7

4、语句中的表达式之间用空格隔开。如

    for (expr1; expr2; expr3)

# 2.3 括号 - ()

1、左括号“(” 不要紧靠关键字，中间用一个空格隔开。

2、左括号“(” 与方法名之间不要添加任何空格。

3、没有必要的话不要在返回语句中使用()。如

 if (condition)
      Array.Remove(1)
      return 1

1
2
3

# 2.4 花括号 - {}

1、左花括号 “{” 放于关键字或方法名的下一行并与之对齐。如

if (condition)
{

}
public int Add(int x, int y)
{

}

1
2
3
4
5
6
7
8

2、左花括号 “{” 要与相应的右花括号 “}”对齐。

3、通常情况下左花括号 “{”单独成行，不与任何语句并列一行。

4、 if、while、do 语句后一定要使用{}，即使{}号中为空或只有一条语句。如

  if (somevalue == 1)
  {
       somevalue = 2;
  }

5、右花括号 “}” 后建议加一个注释以便于方便的找到与之相应的 {。如

 while (1)
{
     if (valid)
     {

     } // if valid
	 else
	 {

     } // not valid

} // end forever

1
2
3
4
5
6
7
8
9
10
11
12

# 第三章程序注释

# 3.1 文件注释

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

/*----------------------------------------------------------------
      // Copyright (C) 2018 公司名称
      // 文件名：
      // 功能描述：
      // 创建时间：
	  // 创建人：
      // 修改时间
      // 修改人
      // 修改描述：
---------------------------------------------------------------*/

1
2
3
4
5
6
7
8
9
10

一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。

在所有的代码修改处加上修改标识的注释。

# 3.2 类注释

/// <summary>
///
/// </summary>

1
2
3

# 3.3 method 注释

/// <summary>
///
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
public Void OperData(object data)
{

}

1
2
3
4
5
6
7
8
9

# 3.4 成员注释

public , protected, property
/// <summary>
///
/// </summary>

1
2
3
4

# 3.5 单行注释

该类注释用于

// 注释语句
private int number;
// always true
if ( 1 == 1)
{
 statement;
}

1
2
3
4
5
6
7

# 第五章命名规范

# 5.1 命名概述

所有类型、方法、参数、变量的命名尽量不使用缩写，包括大家熟知的缩写，例如 msg。

除了用于循环迭代的变量以外，不使用单个字母的变量, 像 i、m、n，使用 index 等来替换，

优先考虑英文，如果英文没有合适的单词描述，可以使用拼音，使用中文是不符合要求的。

唯一可以使用中文的地方是枚举的枚举项，枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明，如下图所示：

# 5.2 命名空间

1、命名指南:

公司名称.技术名称(产品命名).[功能].[设计]

CompanyName.TechnologyName.Feature

例如：

Dist.Dme.Model

Dist.Dme.Algorithms.PopulationCalculation

1
2
3

2、命名要求:

1)命名空间使用 Pascal 大小写，用小数点分隔开。

2)TechnologyName 指的是该项目的英文缩写，或产品名。 3)命名空间和类不能使用同样的名字

# 5.3 类

1、命名指南：

用名词或名词短语命名类

2、命名要求:

1)使用 Pascal 大小写。

2)不要使用类型前缀，如在类名称上对类使用 C 或者 Cls 前缀。如：CFileStream

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

4)有时候需要提供以字母 I 开始的类名称，虽然该类不是接口。只要 I 是作为类名称组成部分的整个单词的第一个字母，这便是适当的。例如，类名称 IdentityStore 是适当的。在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException 对于从名为 Exception 的类派生的类是适当的名称，原因 ApplicationException 是一种 Exception。请在应用该规则时进行合理的判断。例如，Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件，但是将 Control 作为类名称的一部分将使名称不必要地加长。

public class FileStream

public class Button

public class String

1
2
3
4
5

# 5.4 文件命名组织

1 文件名遵从 Pascal 命名法，扩展名小写。

2 使用统一而又通用的文件扩展名： C# 类 .cs

3 窗口类 MainFrm.cs， LoginFrm.cs， SplashFrm.cs

4 类型名称和源文件名称必须一致，当类型命名为 Product 时，其源文件命名只能是 Product.cs。

# 5.5 接口

1、命名指南：

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

名词,接口名称 ICustomAttributeProvider 使用名词短语。名称 IPersistable 使用形容词

2、命名要求：

使用 Pascal 大小写。
不要使用下划线字符 (_)。
给接口名称加上字母 I 前缀，以指示该类型为接口。在定义类/接口对（其中类是接口的标准

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

public interface IComponent
{
   // Implementation code goes here.
}

public class Component: IComponent
{
   // Implementation code goes here.
}

1
2
3
4
5
6
7
8
9

# 5.6 字段

1、命名指南：

使用名词或名词短语命名属性

2、命名要求：

private、protected 使用 Camel 大小写。
public 使用 Pascal 大小写。
拼写出字段名称中使用的所有单词。仅在开发人员一般都能理解时使用缩写。字段名称不

要使用大写字母。下面是正确命名的字段的示例。

class SampleClass
{
    string url;
    string destinationUrl;
}

1
2
3
4
5

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

5、不要对字段名或静态字段名应用前缀。具体说来，不要对字段名称应用前缀来区分静态和非静态字段。例如，应用 g* 或 s* 前缀是不正确的。

6、对预定义对象实例使用公共静态只读字段。如果存在对象的预定义实例，则将它们声明为

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

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

class Test
{
	//字段
	private int backColor;
	public int BackColor;

	//property
	private Color _backColor;
	public Color BackColor
	{
		set
		get
	}
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 5.7 方法

1、命名指南：

使用动词或动词短语命名方法

2、命名要求：

使用 Pascal 大小写。
无论 private, protected, public 都 Pascal

RemoveAll() GetCharArray()

# 5.8 属性 (property)

1、命名指南：

使用名词或名词短语命名属性。

2、命名要求：

使用 Pascal 大小写。

不要使用匈牙利语表示法。

4 考虑用与属性的基础类型相同的名称创建属性。例如，如果声明名为 Color 的属性，则属

性的类型同样应该是 Color。请参阅本主题中后面的示例。

public class SampleClass
{
    private Color _backColor;
    public Color BackColor
    {
        // Code for Get and Set accessors goes here.
    }
}

1
2
3
4
5
6
7
8

# 5.9 事件

1、命名指南：

使用动名词（动词的“ing”形式）创建表示事件前的概念的事件名称，用过去式表示事

件后。例如，可以取消的 Close 事件应当具有 Closing 事件和 Closed 事件。不要使用

BeforeXxx/AfterXxx 命名模式。

2、命名要求：

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

2、指定两个名为 sender 和 e 的参数。sender 参数表示引发事件的对象。sender 参数始

终是 object 类型的，即使在可以使用更为特定的类型时也如此。与事件相关联的状态封装

在名为 e 的事件类的实例中。对 e 参数类型使用适当而特定的事件类。

3、用 EventArgs 后缀命名事件参数类。

4、考虑用动词命名事件。

5、不要在类型的事件声明上使用前缀或者后缀。例如，使用 Close，而不要使用 OnClose。

6、通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法（称为

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;}
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# 5.10 枚举 (Enum)

枚举 (Enum) 值类型从 Enum 类继承。以下规则概述枚举的命名指南：

1 对于 Enum 类型和值名称使用 Pascal 大小写。

2 少用缩写。

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

4 对大多数 Enum 类型使用单数名称，但是对作为位域的 Enum 类型使用复数名称。

5 总是将 FlagsAttribute 添加到位域 Enum 类型。

# 5.11 参数

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

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

2、使用描述参数的含义的名称，而不要使用描述参数的类型的名称。开发工具将提供有关参数的类型的有意义的信息。因此，通过描述意义，可以更好地使用参数的名称。少用基于类型的参数名称，仅在适合使用它们的地方使用它们。

3、不要使用保留的参数。保留的参数是专用参数，如果需要，可以在未来的版本中公开它们。相反，如果在类库的未来版本中需要更多的数据，请为方法添加新的重载。

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

以下是正确命名的参数的示例。

Type GetType(string typeName)
string Format(string format, args() As object)

1
2

# 5.12 变量

变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。如

void MyMethod()
{
    int int1 = 0;     // beginning of method block
    if (condition)
    {
        int int2 = 0;   // beginning of "if" block
        ...
    }
}

1
2
3
4
5
6
7
8
9

不过也有一个例外,类似如下请求

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

1
2
3
4

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

int count;

void MyMethod()
{
    if (condition)
    {
        int count = 0;   // 避免
           ...
    }
    ...
}

1
2
3
4
5
6
7
8
9
10
11

# 5.13 常量 (const)

1、命名指南：

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

   public const string PAGE_TITLE = "Welcome";

# 5.14 静态字段

1、命名指南：

使用名词、名词短语或者名词的缩写命名静态字段。

2、命名要求

使用 Pascal 大小写。
对静态字段名称使用匈牙利语表示法前缀。
建议尽可能使用静态属性而不是公共静态字段。

# 5.15 集合

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

建议用复数。

# 5.16 控件名称

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

# 5.17 措词

避免使用与常用的 .NET 框架命名空间重复的类名称。例如，不要将以下任何名称用作类名称：

System、Collections、Forms 或 UI。有关 .NET 框架命名空间的列表，请参阅类库。

另外，避免使用和以下关键字冲突的标识符。

AddHandler	AddressOf	Alias	And	Ansi
As	Assembly	Auto	Base	Boolean
ByRef	Byte	ByVal	Call	Case
Catch	CBool	CByte	Cchar	CDate
CDec	CDbl	Char	Cint	Class
CLng	CObj	Const	Cshort	CSng
CStr	CType	Date	Decimal	Declare
Default	Delegate	Dim	Do	Double
Each	Else	ElseIf	End	Enum
Erase	Error	Event	Exit	ExternalSource
False	Finalize	Finally	Float	For
Friend	Function	Get	GetType	Goto
Handles	If	Implements	Imports	In
Inherits	Integer	Interface	Is	Let
Lib	Like	Long	Loop	Me
Mod	Module	MustInherit	MustOverride	MyBase
MyClass	Namespace	New	Next	Not
Nothing	NotInheritable	NotOverridable	Object	On
Option	Optional	Or	Overloads	Overridable
Overrides	ParamArray	Preserve	Private	Property
Protected	Public	RaiseEvent	ReadOnly	ReDim
Region	REM	RemoveHandler	Resume	Return
Select	Set	Shadows	Shared	Short
Single	Static	Step	Stop	String
Structure	Sub	SyncLock	Then	Throw
To	True	Try	TypeOf	Unicode
Until	volatile	When	While	With
WithEvents	WriteOnly	Xor	Eval	extends
instanceof	package	var

# 5.18 大小写规则*

大写

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

System.IO

System.Web.UI

1
2
3

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

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

# 第七章　语句

# 6.1 每行一个语句

每行最多包含一个语句。如

a++;    //推荐

b--;    //推荐

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

1
2
3
4
5

# 6.2 复合语句

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

1 子语句要缩进。

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

3 即使只有一条子语句要不要省略花括号“ {}”。如

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

1
2
3
4

# 6.3 return 语句

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

return;
return myDisk.size();
return (size ? size : defaultSize);

1
2
3

# 6.4 if、 if-else、if else-if* 语句

if、 if-else、if else-if 语句使用格式

if (condition)
{
    statements;
}

if (condition)
{
    statements;
}
else
{
    statements;
}

if (condition)
{
    statements;
}
else if (condition)
{
    statements;
}
else
{
    statements;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# 6.4 for、foreach 语句

for 语句使用格式

for (initialization; condition; update)
{
    statements;
}

1
2
3
4

空的 for 语句（所有的操作都在 initialization、condition 或 update 中实现）使用格式

for (initialization; condition; update);  // update user id

foreach 语句使用格式

foreach (object obj in array)
{
    statements;
}

1
2
3
4

注意 :

1 在循环过程中不要修改循环计数器。

2 对每个空循环体给出确认性注释。

# 6.5 while 语句

while 语句使用格式

while (condition)
{
    statements;
}

1
2
3
4

空的 while 语句使用格式

while (condition);

# 6.7. do - while 语句

do - while 语句使用格式

do
{
    statements;
} while (condition);

1
2
3
4

# 6.8. switch - case 语句

switch - case 语句使用格式

switch (condition)
{
    case 1:
        statements;
        break;
    case 2:
        statements;
        break;
    default:
        statements;
        break;
}

1
2
3
4
5
6
7
8
9
10
11
12

注意：

1、语句 switch 中的每个 case 各占一行。

2、语句 switch 中的 case 按字母顺序排列。

3、为所有 switch 语句提供 default 分支。

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

# 6.9. *try - catch*** 语句

try - catch 语句使用格式

try
{
    statements;
}catch (ExceptionClass e)
{
    statements;
}
finally
{
    statements;
}

1
2
3
4
5
6
7
8
9
10
11

# 6.10. using *块语句***

using 块语句使用格式

using (object)
{
    statements;
}

1
2
3
4

# 6.11. * region块语句

wps1

# 附录一: *匈牙利命名法

匈牙利命名法是一名匈牙利程序员发明的，而且他在微软工作了多年。此命名法就是通过微软的各种产品和文档传出来的。多数有经验的程序员，不管他们用的是哪门儿语言，都或多或少在使用它。

这种命名法的基本原则是：

变量名＝属性＋类型＋对象描述

即一个变量名是由三部分信息组成，这样，程序员很容易理解变量的类型、用途，而且便于记忆。

下边是一些推荐使用的规则例子，你可以挑选使用，也可以根据个人喜好作些修改再用之。

⑴ 属性部分：

全局变量： g_

常量： c_

类成员变量： m_

⑵ 类型部分：

指针： p

句柄： h

布尔型： b

浮点型： f

无符号： u

⑶ 描述部分：

初始化： Init

临时变量： Tmp

目的对象： Dst

源对象： Src

窗口： Wnd

下边举例说明：

hwnd： h 表示句柄，wnd 表示窗口，合起来为“窗口句柄”。

m_bFlag： m 表示成员变量，b 表示布尔，合起来为：“某个类的成员变量，布尔型，是一个状态标志”。

# 第一章 概述

# 术语定义

# Pascal 大小写（大驼峰）

# Camel 大小写（小驼峰）

# 第二章 代码标准

# 第三章 代码外观

# 2.1 缩进

# 2.2 空格

# 2.3 括号 - ()

# 2.4 花括号 - {}

# 第三章 程序注释

# 3.1 文件注释

# 3.2 类注释

# 3.3 method 注释

# 3.4 成员注释

# 3.5 单行注释

# 第五章 命名规范

# 5.1 命名概述

# 5.2 命名空间

# 5.3 类

# 5.4 文件命名组织

# 5.5 接口

# 5.6 字段

# 5.7 方法

# 5.8 属性 (property)

# 5.9 事件

# 5.10 枚举 (Enum)

# 5.11 参数

# 5.12 变量

# 5.13 常量 (const)

# 5.14 静态字段

# 5.15 集合

# 5.16 控件名称

# 5.17 措词

# 5.18 ***大小写*****规则***

# 第七章 语句

# 6.1 每行一个语句

# 6.2 复合语句

# 6.3 return 语句

# 6.4 *if***、* *if-else*、***if else-if* ***语句***

# 6.4 *for***、***foreach* ***语句***

# 6.5 while 语句

# 6.7. do - while 语句

# 6.8. switch - case 语句

# 6.9. ** try - catch 语句

# 6.10. ** using 块语句

# 6.11. *** region***块* ***语句***

# 附录一: ***匈牙利*****命名法***

# 第一章　概述

# 第二章代码标准

# 第三章代码外观

# 第三章程序注释

# 第五章命名规范

# 5.18 大小写规则*

# 第七章　语句

# 6.4 if、 if-else、if else-if* 语句

# 6.4 for、foreach 语句

# 6.9. *try - catch*** 语句

# 6.10. using *块语句***

# 6.11. * region块语句

# 附录一: *匈牙利命名法