C语言-格式书写规范.doc

C语言书写规范指南 第1章文件结构 每个C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。 C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀。 1.1版权和版本的声明 版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有： （1）版权信息。 （2）文件名称，标识符，摘要。 （3）当前版本号，作者/修改者，完成日期。 （4）版本历史信息。 /* *Copyright(c)2001,吉林大学物理学院无线电 *Allrightsreserved. * *文件名称：filename.h *文件标识： *摘 要：简要描述本文件的内容 * *当前版本：1.1 *作 者：输入作者（或修改者）名字 *完成日期：2007年7月20日 * *取代版本：1.0 *原作者 ：输入原作者（或修改者）名字 *完成日期：2007年5月10日 */ 示例1-1版权和版本的声明 1.2头文件的结构 头文件由三部分内容组成： （1）头文件开头处的版权和版本声明（参见示例1-1）。 （2）预处理块。 （3）函数和类结构声明等。 假设头文件名称为 SCL_SPI.h，头文件的结构参见示例1-2。 【规则1-2-1】为了防止头文件被重复引用，应当用 #ifndef/#define/#endif结构产生预处理块。 【规则1-2-2】用 #include <filename.h>格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。 【规则1-2-3】用 #include “filename.h”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。 【规则1-2-4】 #include 后面使用TAB键控制排版 。 【规则1-2-5】头文件中只存放“声明”而不存放“定义” 【规则1-2-6】全局变量在头文件中声明,在.c文件中定义 .h extern in tvalue; 声明。 .c in tvalue=0x10; 定义。 【规则1-2-7】局部变量在.c中定义 (static) unsigned in tvalue; 定义。 //版权和版本声明见示例1-1，此处省略。 #ifndef SCL_SPI_H //防止SCL_SPI.h被重复引用 #define SCL_SPI_H #include <p30f6014A.h> //引用标准库的头文件 … #include “SCL_CAN.h” //引用非标准库的头文件 … void Function1(…);//全局函数声明 … extern unsign int value;//全局变量声明 #endif 示例1-2C头文件的结构 1.3定义文件的结构 定义文件有三部分内容： （1）定义文件开头处的版权和版本声明（参见示例1-1）。 （2）对一些头文件的引用。 （3）程序的实现体（包括数据和代码）。 假设定义文件的名称为SCL_SPI.c，定义文件的结构参见示例1-3。 //版权和版本声明见示例1-1，此处省略。 #include“SCL_SPI.h” //引用头文件 … //全局变量定义 unsign int value = 0x10; //全局函数的实现体 void Function1(…) { … } 示例1-3C定义文件的结构 1.4头文件的作用 早期的编程语言如Basic、Fortran没有头文件的概念，C语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释： （1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。 （2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。 1.5目录结构 如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。 例如可将头文件保存于 include 目录，将定义文件保存于 source 目录（可以是多级目录）。 如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。 第2章程序的版式 版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。 可以把程序的版式比喻为“书法”。好的“