C代码编写规范

目录

C代码编写规范.......................................................................... 错误！未定义书签。概述.. (3)

规则 (3)

1.1 文件结构 (3)

1.1.1 文件扩展名 (3)

1.1.2 版权和版本的声明 (3)

1.1.3 头文件和定义文件结构 (4)

1.2 程序排版 (7)

1.2.1 概述 (7)

1.2.2 缩进、空行、空格与对齐 (7)

1.2.3 长行拆分 (9)

1.2.4 修饰符的位置 (10)

1.2.5 注释 (10)

1.2.6 可读性 (12)

1.2.7 自定义类型 (13)

1.2.8 预编译指令 (14)

1.3 命名规则 (15)

1.3.1 基本原则 (15)

1.3.2 具体命名原则 (15)

1.4 表达式和基本语句 (17)

1.4.1 表达式 (17)

1.4.2 基本语句 (17)

1.4.3 常量规则 (18)

1.4.4 变量规则 (19)

1.4.5 结构 (19)

1.5 函数规则 (22)

1.5.1 参数规则 (22)

1.5.2 返回值的规则 (22)

1.5.3 函数内部规则 (23)

1.5.4 函数使用方法 (23)

1.5.5 函数建议 (25)

1.5.6 断言 (26)

1.6 代码编辑、编译与审查 (27)

1.6.1 代码编辑 (27)

1.6.2 代码编译 (27)

1.6.3 代码审查 (28)

1.7 代码测试与维护 (28)

1.8 宏 (29)

1.9 程序效率 (29)

1.10 质量保证 (31)

附件 (33)

1.11 附件一运算符顺序 (33)

1.12 附件二英文常用缩写 (34)

概述

本文档的目的在于规范C代码撰写，所有软件工程师提交代码必须严格按照本文档执行。

规则

1.1文件结构

1.1.1文件扩展名

每个C程序分为两个文件。一个文件用于保存程序的声明(declaration)，为头文件。另一个文件用于保存程序的实现(implementation)，为定义(definition)文件。

C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀。

1.1.2版权和版本的声明

版权和版本的声明位于头文件和定义文件的开头。主要内容有：

1.版权信息；

2.文件名称，标识符，摘要；

3.当前版本号，作者/修改者，完成日期；

具体的定义如下：

/*

***********************************Copyright (c)********************************

*

*-------------------------------------------------------------------------------

* 文件名: ???.c

* 文件描述: ???

*

* 作者: (姓名、邮箱，QQ等)

* 创建日期: 2009-12-01

*

* 编译环境: Tornado2.0&Wind River Workbench 3.0 TOOL=diab

* 硬件环境: ATMEL AT91SAM9G20 fclk=400M

*-------------------------------------------------------------------------------

* 初始版本： V1.0

*

*----------------------------------修改记录-------------------------------------

* 修改人: 甲乙丙丁

* 修改日期: 2010.8.4

* 当前版本： V1.1

* 修改描述: 新增任务tidtaskTouchScreen

*-------------------------------------------------------------------------------

********************************************************************************

*/

代码区

/*

********************************************************************************

* End Of File

********************************************************************************/

注意：

1.版权版本信息和文件信息必须出现在文件的最开始；

2.其中修改者信息不止一项。当第一位修改者修改完成后，提交到版本

库时，必须填写修改者姓名、修改日期、修改的版本号以及修改描述；

当第二位修改者修改后，在提交到版本库之前，也必须填写相关修改

信息；

3.所有文件必须以”End Of File”字样结束，文件最后空一行；

4.代码区与文件头、尾信息之间各空一行。

1.1.3头文件和定义文件结构

1.1.3.1头文件结构

一般头文件由四部分内容组成：

1.头文件开头处的版权声明和相关信息，详细规则见1.1.2；

2.预处理块，定义宏的区域，必须使用以下的注释，所有定义紧跟注释

之后，不得出现在别的位置；

/****************************************************************************

* Macros

****************************************************************************/

3.定义数据类型，所有数据类型紧跟注释之后，不得出现在别的位置；/****************************************************************************

* Local Types

****************************************************************************/

4.函数声明。对于普通函数声明，声明必须紧跟着定义的函数接口说明

(参见定义文件第8部分)，并且函数接口说明和定义文件中的接口说明