力软敏捷旗舰版编码.pdf

C#编码规范

一、规则

1.程序结构要求

1)程序结构清晰，简单易懂，单个函数的程序行数最好不要超过150行。

2)打算干什么，要简单，直接了当，代码精简，避免程序。

3)尽量使用.NET库函数和公共函数(无特殊情况不要使用外部方法调

用windows的动态库)。

4)不要随意定义全局变量，尽量使用局部变量。

2.可读性要求

1)可读性第一，效率第二。

2)保持注释与代码完全一致。

3)每个源程序文件，都有文件头说明，说明规格见规范。

4)每个函数，都有函数头说明，说明规格见规范。

5)主要变量（结构、联合、类或对象）定义或时，注释能反映其含

义。

6)处理过程的每个阶段都有相关注释说明。

7)在典型算法前都有注释，同时算法在满足要求的情况下尽可能简单。

8)利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，

定义Tab为6个字节。

9)循环、分支层次不要超过五层。

10)注释可以与语句在同一行，也可以在上行。

11)空行和空白字符也是一种特殊注释。

12)一目了然的语句不加注释。

13)注释的作用范围可以为：定义、、条件分支以及一段代码。

14)注释行数（不包括程序头和函数头说明部份）应占总行数的1/5到

1/3

15)常量定义（DEFINE）有相应说明。

3.结构化要求

1)出现两条等价的支路。

2)GOTO语句。

3)用IF语句来强调只执行两组语句中的一组。ELSEGOTO和

ELSERETURN。

4)用CASE实现多路分支。

5)避免从循环引出多个出口。

6)函数只有一个出口。

7)不使用条件赋值语句。

8)避免不必要的分支。

9)不要轻易用条件分支去替换逻辑表达式。

4.正确性与容错性要求

1)程序首先是正确，其次是优美

2)无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检

查。

3)改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程

序的影响。

4)所有变量在调用前必须被初始化。

5)对所有的用户输入，必须进行检查。

6)不要比较浮点数的相等，

7)如：10.0*0.11.0，不可靠

8)程序与环境或状态时，必须主动去处理发生的意外，如

文件能否逻辑锁定、是否联机等，对于明确的错误，要有明确

的容