周立功代码规范.docVIP

程序代码写作规范（草案）（版本：1.0） 基本要求 程序结构清析，简单易懂，单个函数的程序行数不得超过100行。 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。 尽量使用公共函数，c51的标准库函数谨慎使用。 不要随意定义全局变量，尽量使用局部变量。 使用括号以避免二义性。 非万不得已不要使用浮点运算。一般的小数运算可以使用定点数实现。 可读性要求 可读性第一，效率第二。 保持注释与代码完全一致。 每个源程序文件，都有文件头说明，说明规格见规范。 每个函数，都有函数头说明，说明规格见规范。 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。 常量定义（define）有相应说明。 处理过程的每个阶段都有相关注释说明。 在典型算法前都有注释。 利用缩进来显示程序的逻辑结构，缩进量一致并以4个空格为单位。 循环、分支层次不要超过五层。 注释可以与语句在同一行，也可以在上行。 空行和空白字符也是一种特殊注释。 一目了然的语句不加注释。 注释的作用范围可以为：定义、引用、条件分支以及一段代码。 结构化要求 禁止出现两条等价的支路。 非必要不要使用goto语句。goto一般用于从内循环直接跳到循环外部、检测到错误直接跳到错误处理程序。影响可读性时禁止使用goto语句。 用 if 语句来强调只执行两组语句中的一组。 用 case 实现多路分支。 避免从循环引出多个出口。 尽量减少函数的出口。 避免不必要的分支。 不要轻易用条件分支去替换逻辑表达式。 正确性与容错性要求 程序首先是正确，其次是优美。 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。 改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。 所有变量在调用前必须被初始化。 对所有的用户输入，必须进行合法性检查。 不要比较浮点数的相等，如： 10.0 * 0.1 == 1.0 ， 不可靠。 函数对接受的参数应该进行合法性检查。 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。 尽量不要使用==作为判断条件，应该用=,或=替代。 可重用性要求 所有c语言程序文件只包含一个头文件config.h，在config.h中包含其它头文件。 重复使用的完成相对独立功能的算法或代码应编入一个文件，并且使用头文件 设定一些与硬件相关的参数，这些参数在config.h中定义，模块自己的头文件仅说明如何设定这些参数。 公共代码应考虑OO思想，减少外界联系，考虑独立性或封装性。 尽量少使用与编译器相关的特性。 取变量占用内存长度用sizeof(变量类型)而不用常量。 命名规则 变量命名 命名必须具有一定的实际意义，要“望文知义”。 根据变量的作用域决定名字的长短。作用域越大，名字越长。在整个程序中都要使用的变量就要长一些；而局部变量就可以短一些。 变量名中每一个单词首字母大以分隔单词。一些习惯单词如OK可以全部大写。 局部变量中可采用如下几个通用变量：Temp，N，i，j（一般用于循环变量）。 常量命名和宏定义 常量和宏定义必须具有一定的实际意义。 局部使用的常量和宏定义在#include和函数定义之间。 常量和宏定义必须全部以大写字母来撰写,中间可根据意义的连续性用下划线连接,每一条定义的右侧必须有一简单的注释,说明其作用。 函数命名 函数命名一般使用动名或动宾结构，要有实际意义。变量名中每一个单词首字母大写。 结构体命名 结构体类型命名必须全部用大写字母,原则上前面以下划线开始;结构体变量命名必须用大小写字母组合，必要时可用下划线间隔。数据定义需注明其用途。 注释 原则上注释要求使用中文。 文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复杂的算法需要加上流程说明。 函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明。 程序中注释包括:修改时间和作者、方便理解的注释等。 引用一 文件开头的注释模板 /*************************************Copyright********************************* ** ** 3 + 1 班 ** 06届 ** ** ** **--------------文件信息----------------------------------------------------------------------------