C语言头文件编写的几个基本规则

1.       注释，版权，作者，重大修订记录等信息

2.       防重入开关，也就是常见的 #ifndef… #define… #endif

3.       C++ 编译器自适应开关，也就是常见的 #ifdef __cplusplus… extern “C” { } #endif

4.       #include ，头文件里应该 include 所有该文件中所使用的其它接口头文件。这里有也有两层含义，一是说头文件应做到自包含，即使用头文件的用户不需要再为该头文件 include 其它头文件；二是从模块耦合内聚角度来说，头文件中本身不应该 include 太多其它头文件，一般就是通用数据类型定义， include 其它头文件意味着强耦合——引用了其它头文件中的类型定义，宏或是函数。

5.       接口声明及注释，包括函数，结构体等，但不应该出现全局变量，和 static 类型的接口，这些都应该是放置在 C 文件中。函数的注释中应该包括功能说明，参数使用方法，可能的返回值，及其它注意事项。结构体的注释中应该包括每个成员变量所表示的含义。我们也提倡自注释，即通过合理的命名达到见名知意的效果。

6.       接口总体上来说是越少，越简单越好，时刻检查头文件中是否存在冗余的信息，及时删除，合并。

一些初学C语言的人，不知道头文件（*.h文件）原来还可以自己写的。只知道调用系统库 函数时，要使用#include语句将某些头文件包含进去。其实，头文件跟.C文件一样，是可以自己写的。头文件是一种文本文件，使用文本编辑器将代码编写好之后，以扩展名.h保存就行了。头文件中一般放一些重复使用的代码，例如函数声明，变量声明，常数定义，宏的定义等等。当使用#include语句将头文件引用时，相当于将头文件中所有内容，复制到#include处。为了避免因为重复引用而导致的编译错误，头文件常具有 
#ifndef     LABEL

#define     LABEL

     //代码部分

#endif

的格式。其中，LABEL为一个唯一的标号，命名规则跟变量的命名规则一样。常根据它所在的头文件名来命名，例如，如果头文件的文件名叫做hardware.h，

那么可以这样使用：

#ifndef     __HARDWARE_H__

#define     __HARDWARE_H__

   //代码部分

#endif

这样写的意思就是，如果没有定义__HARDWARE_H__，则定义__HARDWARE_H__，并编译下面的代码部分，直到遇到#endif。这样，当重复引用时，由于__HARDWARE_H__已经被定义，则下面的代码部分就不会被编译了，这样就避免了重复定义。

另外一个地方就是使用include时，使用引号与尖括号的意思是不一样的。使用引号(“”)时，首先搜索工程文件所在目录，然后再搜索编译器头文件所在目录。而使用尖括号(<>)时，刚好是相反的搜索顺序。假设我们有两个文件名一样的头文件hardware.h，但内容却是不一样的。一个保存在编译器指定的头文件目录下，我们把它叫做文件I；另一个则保存在当前工程的目录下，我们把它叫做文件II。如果我们使用的是#include <hardware.h>，则我们引用到的是文件I。如果我们使用的是#include “hardware.h”，则我们引用的将是文件II。笔者以前就遇到过一个同事问，为什么他修改了那个头文件里面的内容，好象跟没有修改一样？就是因为他有两个一样的头文件（就像我们刚描述的那样），他是使用#include<hardware.h>引用的，而他修改时，却是当前工程所在的目录下的那个文件。