C代码规范及建议.pdf

目 录 一、 文件结构 1．1 版权和版本的声明 1．2 头文件的结构 1．3 定义文件的结构 二、文件的版式 2．1 空行的用法 2．2 代码行 2．3 代码行内的空格 2．4 对齐 2．5 长行拆分 2．6 修饰符的位置 2．7 注释 三、命名规则 3．1 命名基本规则 四、表达式和基本语句 4．1 运算符的优先级 4．2 复合表达式 4．3 if 语句 4．4 循环语句的效率 五、函数设计 5．1 参数的规则 5．2 返回值的规则 5．3 函数内部实现的规则 5．4 其它建议 六、其它经验和建议 6．1 提高程序的效率 一、文件结构 每个C程序通常分为两个文件。一个文件用于保存程序的声明（dec laration ），称为头文件。 另一个文件用于保存程序的实现（implementation ），称为定义（definition ）文件。 C程序的头文件以“.h”为后缀，C程序的定义文件以“.c ”为后缀 1．1 版权和版本的声明 版权和版本的声明位于头文件和定义文件的开头，主要内容有： （1）版权信息。 （2 ）文件名称，文件内容摘要。 （3 ）当前版本号，最后修改日期。 格式如下： /* 文件名称 空行 文件摘要 Version 版本号 Last Modify: 最后更改日期 Copyright (c) 2006 Shenzhen International Solution Software Co., Ltd. All rights reserved. */ 示例如下： /* Siss8118.h Header file for Siss5118 Version 1.0 Last Modify: 2005.12.30 Copyright (c) 2006 Shenzhen International Solution Software Co., Ltd. All rights reserved. */ 示例1-1 版权和版本的声明 1．2 头文件的结构 头文件由三部分内容组成： （1）头文件开头处的版权和版本声明 （2 ）预处理块 （3 ）函数和结构体声明等 假设头文件名称为 Syscfg.h，头文件的结构参见示例 1.2.1 为了防止头文件被重复引用，应当用#ifndef/#define/#endif 结构产生预处理块 1.2.2 用#include filename.h 格式来引用标准库的头文件（编译器将从库目录开始搜索） 1.2.3 用#include “filename.h” 格式来引用非标准库的头文件(编译器将从工作目录开始搜索) 1.2.4 头文件中只存放函数和变量的“声明”而不存放函数和变量的“定义” 1.2.5 结构体定义应使用typedef定义结构体别名，避免直接使用struct直接定义结构体。 1.2.6 尽量避免使用全局变量，确实需要使用全局变量供其它模块引用时，必须在头文件中 使用类似extern int value声明。 1.2.7 头文件中存放需要引用的特殊宏(使用#define定义的宏替换) 1.2.8 在函数声明前存放函数需要引用的常量宏(使用#define定义的常量) 示例如下： // 版权和版本声明见示例1- 1，此处省略。 #ifndef _SYSCFG_H // 防止syscfg.h 被重复引用 #define _SYSCFG_H #include absacc .h // 头文件中需要引用标准库的头文件 … #include “main.h” // 头文件中需要引用非标准库的头文件 … #define MEM_TYPE code // 特殊宏定义 typedef struct //结构体定义 { … }tSysCfg; extern int iSysStatus; //全局变量声明 #define SYS_RUNNING_STATUS 1 // 全局函数引用宏定义 #define SYS_CONFI