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

《X项目开发规范与三层架构》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、18C#项目开发规范与三层架构使用C#进行大型项目开发时，不仅需要技术支持，还需要一定的开发理念和项目规范，对于C#来言，大型项目的开发理念是三层结构模式，项目规范则包括命名、格式、注释、文档、标准等，本章则从编程规范和开发模式上论述项目开发方面的技术。主要包括以下内容：ò规范化命名。ò编码规范。ò用户界面规范。ò三层结构的搭建。对代码中命名规则、缩进、换行和C#编程规范注释等方面提出的要求，同时还包括程序结构方面的规定三层结构开发模式如何搭建三层结构开发模式图解C#开发实战18.1认识C#编程规范软件开发的最终成果通常以可执行文件、代码、用户手

2、册、相关培训和服务等形式体现，其中核心是代码。编程规范主要体现在对代码中命名规则、缩进、换行和注释等方面提出的要求，同时还包括程序结构方面的规定。C#编程规范基本要求如下。1．程序结构要求ò程序结构清晰，简单易懂，单个函数的程序行数不得超过100行。ò打算干什么，要简单，直接了当，代码精简，避免垃圾程序。ò尽量使用.NET库函数和公共函数（无特殊情况不要使用外部方法调用Windows的核心动态链接库）。ò不要随意定义全局变量，尽量使用局部变量。2．可读性要求ò可读性第一，效率第二（代码是给人读的）。ò保持注释与代码完全一致。ò每个源程序文件，都有

3、文件头说明，说明规格见规范。ò每个函数，都有函数头说明，说明规格见规范。ò主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。ò处理过程的每个阶段都有相关注释说明。ò在典型算法前都有注释，同时算法在满足要求的情况下尽可能简单。ò利用缩进来显示程序的逻辑结构，缩进量一致并以“Tab”键为单位，定义Tab为6个字节。ò循环、分支层次不要超过5层。ò注释可以与语句在同一行，也可以在上行。ò空行和空白字符也是一种特殊注释。ò一目了然的语句不加注释。ò注释的作用范围可以为定义、引用、条件分支及一段代码。ò注释行数（不包括程序头和函数头说明部份）

4、应占总行数的1/5到1/3。ò常量定义（DEFINE）有相应说明。446C#项目开发规范与三层架构183．结构化要求ò禁止出现两条等价的支路。ò禁止GOTO语句。ò用IF语句来强调只执行两组语句中的一组。禁止ELSEGOTO和ELSERETURN，用CASE实现多路分支。ò避免从循环引出多个出口。ò函数只有一个出口。ò不使用条件赋值语句。ò避免不必要的分支。ò不要轻易用条件分支去替换逻辑表达式。4．正确性与容错性要求ò程序首先是正确，其次是优美。ò无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。ò改一个错误时可能产生新的错误，因此

5、在修改前首先考虑对其他程序的影响。ò所有变量在调用前必须被初始化。ò对所有的用户输入，必须进行合法性检查。ò不要比较浮点数的相等，如10.0*0.1==1.0，不可靠。ò程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等，对于明确的错误，要有明确的容错代码提示用户。ò单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。ò尽量使用规范的容错语句。例如：try{}catch{}finally{}5．可重用性要求ò重复使用的完成相对独立功能的算法或代码应抽象为ASP.NET服务或类。òASP.NET

6、服务或类应考虑OO思想，减少外界联系，考虑独立性或封装性。447图解C#开发实战18.1.1如何规范化命名选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开，表现力强的名称是为了帮助人们阅读。因此，提供人们可以理解的名称是有意义的。不过，要保证选择的名称符合适用语言的规则和标准。1．变量（Variable）命名规范程序中变量名称=变量的前缀+代表变量含义的英文单词或单词缩写。ò类模块级的变量以“m_”作前缀，例如：publicclasshello{pri

7、vatestringm_Name;privateDateTimem_Date;}ò类的属性所对应的变量，采用属性名前加“m_”前缀的形式，例如：publicclasshello{privatestringm_Name;publicstringName{get{returnm_Name;}}}ò过程级的变量不使用前缀，例如：publicclasshello{voidsay(){stringSayWord;}}ò过程的参数使用“p_”作为参数，例如：publicclasshello{voidsay(stringp_SayWord)448C#项目开发规

8、范与三层架构18{}}ò针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为e；如果有冲突的情况下，可以重复e