1、C#开发编程规范(基本要求)1.1 程序结构要求 : 1. 程序结构清晰,简单易懂,单个函数的程序行数不得超过 100 行。 2. 打算干什么,要简单,直截了当,代码精简,避免垃圾程序。 3. 尽量使用.NET 库函数和公共函数(无特殊情况不要使用外部方法调用windows 的核心动态链接库 API)。 4. 不要随意定义全局变量,尽量使用局部变量。 1.2 可读性要求: 1. 可读性第一,效率第二(保证后期维护的简易)。 2. 保持注释与代码完全一致。 3. 每个源程序文件,都有文件头说明,说明规格见规范。 4. 每个函数,都有函数头(使用 XML 注释)说明,说明规格见规范。 5. 主要变
2、量(结构、联合、类或对象)定义或引用时,注释能反映其含义。 6. 处理过程的每个阶段都有相关注释说明。 7. 在典型算法前都有注释, 同时算法在满足要求的情况下尽可能简单。 8. 利用缩进来显示程序的逻辑结构,缩进量一致并以 VS 自动生成为准,不采用空格进行缩进。 9. 循环、分支层次不要超过五层。 10. 注释可以与语句在同一行,也可以在上行。 11. 空行和空白字符也是一种特殊注释。 12. 一目了然的语句不加注释。 13. 注释的作用范围可以为:定义、引用、条件分支以及一段代码。 14. 注释行数(不包括程序头和函数头说明部份)应占总行数的 1/5 到 1/3 1.3 结构化要求 :
3、1. 禁止出现两条等价的支路。 2. 除了在 Switch 关键字的作用域内,禁止 GOTO 语句。 3. 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。 4. 用 CASE 实现多路分支。 5. 避免从循环引出多个出口。 6. 函数只有一个出口。 7 不使用条件赋值语句。 8 避免不必要的分支。 9 不要轻易用条件分支去替换逻辑表达式 1.4 正确性与容错性要求: 1. 程序首先是正确,其次是优美 2. 无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。 3. 改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响
4、。 4. 所有变量在调用前必须被初始化。 5. 对所有的用户输入,必须进行合法性检查。 6. 尽量不要比较浮点数的相等,如: 10.0 * 0.1 = 1.0 , 不可靠 7. 程序与环境或状态发生关系时,必须主动去处理发生的意外事件,如文件能否逻辑锁定、打印机是否联机等,对于明确的错误,要有明确的容错代码提示用户,在这样不确定的场合都使用 Try Throw Catch。 8. 单元测试也是编程的一部份,提交联调测试的程序必须通过单元测试。 9. 尽量使用规范的容错语句.例如: Try catch finally1.5.可重用性要求: 1. 重复使用的完成相对独立功能的算法或代码应抽象为 服务或类。 2. 服务或类应考虑 OO 思想,减少外界联系,考虑独立性或封装性。