Csharp编程规范国外标准分享.pdf

U8.C#代码规范2

1.引言2

2.文件2

2.1文件基本规范2

2.2C#源程序组织...…………2

2.3文档排版3

3.命名规范3

3.1基本规则3

3.2命名空间命名4

3.3常量命名5

3.4变量命名5

3.5枚举类型6

3.6接口命名6

3.7类命名6

3.8方法命名7

3.9属性命名（property）7

3.10事件命名8

3.11特性命名（Attribute）9

3.12集合9

4.编码规范9

4.1基本原则9

4.2类编写规范10

4.3声明10

4.4语句11

4.5空白13

4.5.1空行13

4.5.2空格13

4.6方法13

5.注释13

5.1基本规则13

5.2实现注释14

5.2.1单行注释//14

5.2.2块注释：/**/15

5.3文档注释15

5.4类/接口注释16

5.5方法注释16

5.6算法注释17

5.7修改注释17

U8.C#代码规范

1.引言

规范化的代码是软件质量的保证手段之一，也是软件过程能够流畅的基础，其

重要性是不言而喻的。相信我们的每一位开发人员都知道代码规范的重要性，而且

大家也都在努力实现代码的规范化，只是在执行力度和重视程度上有所差异而已。

另外，由于实际易行的关于代码规范的文档的缺乏，以及普及度的不足，也是一个

因素。

本文档，力争做到简明易行，主要分为两个部分。其中，关于命名规则、编码

规范及文档排版等硬规则都遵从C#本身的规范，本文档只作简要介绍，若有遗漏，

大家可参考.NETFrameworkSDK文档。另外一个部分，则主要是针对代码的注释。

本文档适用于软件开发过程中开发人员，主要包括编码人员、测试人员，开发

人员，规范必须严格遵守，否则程序被视为不合格程序。

建议：代码抽查，根据规范进行检查，只有这样，才能保证执行力度。

2.文件

2.1文件基本规范

1.源代码文件后缀采用系统缺省后缀，C#源代码文件为*.CS，不要使用自定

义后缀作为源码文件的后缀。

2.文件除了包含代码本身外，还包含空白行和辅助注释信息；单个文件的代码

行数不要超过2000行。

3.源程序文件的划分及其内容的组织，应尽量从完成某个功能出发。

4.建议不要在一个源代码文件中定义多个公共类的定义，尽量保持单个源代码

文件中只包含一个公共的类以及若干辅助性的私有类、接口、结构、枚举以

及/委派的定义。

2.2C#源程序组织

1.单个程序文件内容，一般包括名空间导入，然后声明次一级编程元素，如类

/接口/委派等。

20242

2.名空间导入：必须在文件头部统一使用名空间导入语句导入；对于来自不同

程序集的名空间，可以使用空行进行逻辑编排。

3.源文件中元素的组织，一般按照如下顺序组织：

1)名空间（命名规则参考本文“命名规范”一节）