X项目开发规范与三层架构.pdfVIP

18 C#项目开发规范与三层架构 使用 C#进行大型项目开发时，不仅需要技术支持，还需要一定的开发理念和项目规范， 对于 C#来言，大型项目的开发理念是三层结构模式，项目规范则包括命名、格式、注释、 文档、标准等，本章则从编程规范和开发模式上论述项目开发方面的技术。 主要包括以下内容： 规范化命名。 编码规范。 用户界面规范。 三层结构的搭建。 对代码中命名规则、缩进、换行和 C#编程规范 注释等方面提出的要求，同时还包 括程序结构方面的规定 三层结构开发模式 如何搭建三层结构开发模式 图解 C#开发实战 18.1 认识 C#编程规范 软件开发的最终成果通常以可执行文件、代码、用户手册、相关培训和服务等形式体现， 其中核心是代码。编程规范主要体现在对代码中命名规则、缩进、换行和注释等方面提出的 要求，同时还包括程序结构方面的规定。 C#编程规范基本要求如下。 1．程序结构要求 程序结构清晰，简单易懂，单个函数的程序行数不得超过 100 行。 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。 尽量使用.NET 库函数和公共函数（无特殊情况不要使用外部方法调用 Windows 的 核心动态链接库）。 不要随意定义全局变量，尽量使用局部变量。 2 ．可读性要求 可读性第一，效率第二（代码是给人读的）。 保持注释与代码完全一致。 每个源程序文件，都有文件头说明，说明规格见规范。 每个函数，都有函数头说明，说明规格见规范。 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。 处理过程的每个阶段都有相关注释说明。 在典型算法前都有注释，同时算法在满足要求的情况下尽可能简单。 利用缩进来显示程序的逻辑结构，缩进量一致并以“Tab ”键为单位，定义Tab 为 6 个字节。 循环、分支层次不要超过 5 层。 注释可以与语句在同一行，也可以在上行。 空行和空白字符也是一种特殊注释。 一目了然的语句不加注释。 注释的作用范围可以为定义、引用、条件分支及一段代码。 注释行数（不包括程序头和函数头说明部份）应占总行数的 1/5 到 1/3。 常量定义（DEFINE ）有相应说明。 446 C#项目开发规范与三层架构 18 3．结构化要求 禁止出现两条等价的支路。 禁止 GOTO 语句。 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN ， 用 CASE 实现多路分支。 避免从循环引出多个出口。 函数只有一个出口。 不使用条件赋值语句。 避免不必要的分支。 不要轻易用条件分支去替换逻辑表达式。 4 ．正确性与容错性要求 程序首先是正确，其次是优美。 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。 改一个错误时可能产生新的错误，因此在修改前首先考虑对其他程序的影响。 所有变量在调用前必须被初始化。 对所有的用户输入，必须进行合法性检查。 不要比较浮点数的相等，如 10.0*0.1==1.0，不可靠。 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑 锁定、打印机是否联机等，对于明确的错误，要有明确的容错代码提示用户。 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试