C代码编程格式规范要点.docVIP

C代码编程格式规范 目 录 1 前言 6 2 适用范围 6 3 命名规范 6 3.1 使用的符号、名词及说明 6 3.1.1 尖括号 6 3.1.2 大括号{ } 6 3.1.3 圆括号() 7 3.1.4 省略号... 7 3.1.5 模块定义 7 3.2 标识符的命名 7 3.2.1 全局变量 7 3.2.2 局部变量 7 3.2.3 宏定义 8 3.2.4 结构定义 8 3.2.5 目录命名规范 8 3.2.6 程序命名规范 9 3.2.7 函数命名规范 9 3.2.8 数据字典项 9 3.2.9 通用缩写 9 3.2.10 标识符命名注意问题 9 4 注释 11 4.1 一般情况下 11 4.2 说明性文件头部注释 11 4.3 源文件头部应进行注释 12 4.4 函数头部应进行注释 13 4.5 书写注释注意事项 13 4.5.1 边写代码边注释 13 4.5.2 注释的内容要清楚 13 4.5.3 代码中注释的位置 14 4.5.4 变量、常量的注释方法 14 4.5.5 变量应当成组说明 14 4.5.6 数据结构注释 15 4.5.7 全局变量注释 15 4.5.8 注释与所描述内容进行同样的缩排。 16 4.5.9 将注释与其上面的代码用空行隔开 16 4.5.10 变量的定义和分支语句 16 4.5.11 算法说明 17 4.5.12 特定情况说明 17 4.5.13 switch语句 17 4.5.14 无限循环 17 4.5.15 程序进行修改时注释 17 5 书写格式规范 17 5.1 基本原则 18 5.1.1 缩进 18 5.1.2 空行 18 5.1.3 语句的放置 18 5.1.4 续行 19 5.1.5 逗号操作符 19 5.1.6 语句 20 5.1.7 二元操作符 20 5.2 源文件组成结构 20 5.3 头文件包含 21 5.4 宏定义 21 5.5 类型定义 22 5.6 外部全局变量声明 23 5.7 全局变量定义 23 5.8 局部函数声明 24 5.9 函数定义部分 24 5.9.1 函数头 24 5.9.2 局部变量定义 25 5.9.3 函数正文 25 5.9.4 函数的返回类型说明 28 5.9.5 预处理指令 28 5.10 简单赋值语句 29 5.11 if语句 29 5.11.1 简单if语句结构 29 5.11.2 if / else语句结构 30 5.11.3 else-if链接语句结构 30 5.12 while语句结构 32 5.13 for语句结构 32 5.14 do / while()语句结构 32 5.15 switch语句结构 33 5.15.1 case与default与保留字switch保持同一缩进层次 33 5.15.2 每种情况case单独成一行。 33 5.15.3 case不要用空行分隔开 33 5.15.4 省略了break语句 33 5.15.5 switch语句的最后一种情况 33 5.16 return语句结构 34 6 编程技巧 35 6.1 寄存器变量 35 6.2 尽量不使用goto语句 36 6.3 while、for中使用赋值语句 36 6.4 结构作为参数 36 6.5 复合的赋值运算符 36 6.6 sizeof 37 6.7 变量定义同时为其附初值 37 6.8 释放内存 37 6.9 系统采用统一错误处理机制 37 6.10 返回码 37 7 性能 37 7.1 可测性 37 7.1.1 调测开关的应用 37 7.1.2 调测打印出的信息串的格式要有统一的形式 38 7.1.3 为单元测试选择恰当的测试点 38 7.1.4 构造好测试环境等 38 7.1.5 使用断言来发现软件问题，提高代码可测性 38 7.1.6 用断言来检查调测时有可能发生的非法情况 39 7.1.7 断言检查不了最终产品必须处理的错误 39 7.1.8 对较复杂的断言加上明确的注释 39 7.1.9 用断言确认函数的参数 39 7.1.10 用断言保证没有定义的特性或功能不被使用 39 7.1.11 用断言对程序开发环境的假设进行检查 40 7.1.12 编译器提供的功能及特性假设可用断言检查 41 7.1.13 正式软件产品去掉断言 41 7.1.14 测试手段对软件实现的功能不影响 41 7.1.15 减少维护的难度 41 7.1.16 DEBUG版本和发行版本应该统一维护 41 7.1.17 应预先设计好程序调试与测试的方法和手段 42 7.1.18 调测开关应分为不同级别和类型。 42 7.1.19 编写防错程序 42 7.2 程序效率 43 7.2.1 编程时要经常注意代码的效率 43 7.2.2 局部效率应为全