和规.pptVIP

C# 开 发 编 程 规 范和Web UI 设 计 规 范 郑州锐升软件技术有限公司 第一部分 C# 开 发 编 程 规 范 C#编程规范内容概要 1.基本要求 2.程序 3.注释 4.命名 5.大小写规则 6.缩写 7.措词 第一小节 基本要求 1.1程序结构要求 ： 1.程序结构清晰，简单易懂，单个函数的程序行数不得超过100行。 2.打算干什么，要简单，直截了当，代码精简，避免垃圾程序。 3.尽量使用.NET库函数和公共函数(无特殊情况不要使用外部方法调用windows的核心动态链接库API)。 4.不要随意定义全局变量，尽量使用局部变量。 1.2可读性要求： 1 .可读性第一，效率第二(保证后期维护的简易)。 2. 保持注释与代码完全一致。 3 .每个源程序文件，都有文件头说明，说明规格见规范。 4 .每个函数，都有函数头（使用XML注释）说明，说明规格见规范。 5 .主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。 6 .处理过程的每个阶段都有相关注释说明。 7 .在典型算法前都有注释, 同时算法在满足要求的情况下尽可能简单。 8. 利用缩进来显示程序的逻辑结构，缩进量一致并以VS2008自动生成为准，不采用空格进行缩进。 9 .循环、分支层次不要超过五层。 10. 注释可以与语句在同一行，也可以在上行。 11. 空行和空白字符也是一种特殊注释。 12 .一目了然的语句不加注释。 13 .注释的作用范围可以为：定义、引用、条件分支以及一段代码。 14. 注释行数（不包括程序头和函数头说明部份）应占总行数的 1/5 到 1/3 1.3结构化要求 ： 1 禁止出现两条等价的支路。 2 除了在Switch关键字的作用域内，禁止GOTO语句。 3 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。 4 用 CASE 实现多路分支。 5 避免从循环引出多个出口。 6 函数只有一个出口。 7 不使用条件赋值语句。 8 避免不必要的分支。 9 不要轻易用条件分支去替换逻辑表达式 1.4 正确性与容错性要求： 1 程序首先是正确，其次是优美 2 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。 3 改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。 4 所有变量在调用前必须被初始化。 5 对所有的用户输入，必须进行合法性检查。 6 尽量不要比较浮点数的相等，如： 10.0 * 0.1 == 1.0 ， 不可靠7 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等,对于明确的错误,要有明确的容错代码提示用户，在这样不确定的场合都使用Try Throw Catch。 8 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。 9 尽量使用规范的容错语句. 例如: try { } catch { } finally { } 1.5.可重用性要求： 1 重复使用的完成相对独立功能的算法或代码应抽象为asp.net服务或类。 2 asp.net服务或类应考虑OO思想，减少外界联系，考虑独立性或封装性。 第二小节 程序 1.程序编码力求简洁，结构清晰，避免太多的分支结构及太过于技巧性的程序，尽量不采用递归模式。 2.编写程序时，亦必须想好测试的方法，换句话说，”单元测试” 的测试方案应在程序编写时一并拟好。 3.版本封存以后的修改一定要将老语句用/* */ 封闭，不能自行删除或修改。 4.对于比较大的函数，每个block 和特殊的函数调用，都必须注明其功能。 第三小节 注释 原则上注释要求使用中文; 文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复杂的算法需要加上流程说明; 函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数 需要加上变量用途说明; 程序中注释包括:修改时间和作者、方便理解的注释等; 引用一: 文件开头的注释模板/******************************************************************** 文件名:** Copyright (c) 郑州锐升软件技术有限公司 ** 创建人:** 日 期:** 修改人:** 日 期:** 描 述:**** 版 本:** 引用二: 函数开头的注释模板 /// summary /// /// /summary /// param name=/param /// param name=/param /// author/author