程序编写规范.docVIP

程序编写规范（转） 2011-07-25 15:05 1. 基本要求1.1 程序结构清析，简单易懂，单个函数的程序行数不得超过100行。1.2 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。1.3 尽量使用标准库函数和公共函数。1.4 不要随意定义全局变量，尽量使用局部变量。1.5 使用括号以避免二义性。 2.可读性要求2.1 可读性第一，效率第二。2.2 保持注释与代码完全一致。2.3 每个源程序文件，都有文件头说明，说明规格见规范。2.4 每个函数，都有函数头说明，说明规格见规范。2.5 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。2.7 常量定义（DEFINE）有相应说明。2.8 处理过程的每个阶段都有相关注释说明。2.9 在典型算法前都有注释。2.10 利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为 6个字节。2.11 循环、分支层次不要超过五层。2.12 注释可以与语句在同一行，也可以在上行。2.13 空行和空白字符也是一种特殊注释。2.14 一目了然的语句不加注释。2.15 注释的作用范围可以为：定义、引用、条件分支以及一段代码。2.16 注释行数（不包括程序头和函数头说明部份）应占总行数的 1/5 到 1/3 。 3. 结构化要求3.1 禁止出现两条等价的支路。3.2 禁止GOTO语句。3.3 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。3.4 用 CASE 实现多路分支。3.5 避免从循环引出多个出口。3.6 函数只有一个出口。3.7 不使用条件赋值语句。3.8 避免不必要的分支。3.9 不要轻易用条件分支去替换逻辑表达式。 4. 正确性与容错性要求4.1 程序首先是正确，其次是优美4.2 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。4.3 改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。4.4 所有变量在调用前必须被初始化。4.5 对所有的用户输入，必须进行合法性检查。4.6 不要比较浮点数的相等，如： 10.0 * 0.1 == 1.0 ， 不可靠4.7 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等。4.8 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。 5. 可重用性要求5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。5.2 公共控件或类应考虑OO思想，减少外界联系，考虑独立性或封装性。5.3 公共控件或类应建立使用模板。 　　　　　　　　　 附：C＋＋ 编程规范,delphi作相应的参考 1、结构体命名结构体类型命名必须全部用大写字母,原则上前面以下划线开始;结构体变量命名必须用大小写字母组合，第一个字母必须使用大写字母,必要时可用下划线间隔。对于私有数据区，必须注明其所属的进程。全局数据定义只需注意其用途。　　　　　　　　　 示例如下：　　　　　　　　　 typedef struct　　　　　　　　　 {　　　　　　　　　　　　　 char 　　　　　　　 szProductName[20];　　　　　　　　　　　　　 char 　　　　　　　 szAuthor[20]; 　　　　　　　　　　　　　 char 　　　　　　　 szReleaseDate[16];　　　　　　　　　　　　　 char 　　　　　　　 szVersion[10];　　　　　　　　　　　　　 unsigned long　　　 MaxTables;　　　　　　　　　　　　　 unsigned long　　　 UsedTables;}DBS_DATABASE;DBS_DATABASE GdataBase; 2、注释原则上注释要求使用中文;文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复杂的算法需要加上流程说明;函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明;程序中注释包括:修改时间和作者、方便理解的注释等; 　　引用一: 文件开头的注释模板/******************************************************************** 文件名:** Copyright (c) 1998-1999 *********公司技术开发部** 创建人:** 日　期:** 修改人:** 日　期:** 描　述:**** 版　本:**--