接口规定了模块做什么，仅规定应用程序可能使用的那些标识符，而尽可能隐藏不相关的表示细节和算法。在C语言中，接口通过一个头文件指定，头文件的扩展名通常为.h。这个头文件会声明应用程序可能使用的宏、类型、数据结构、变量和接口声明。应用程序通过预处理指令#include导入接口。
API接口文档分为在线或离线两种，API接口文档一般遵循这些规范：
编程风格
编程风格一致，此外，編程命名函數和变量时，用英文表述它的具体含义。
原子独立
API接口必须是定义明确，功能独立的；如果一个函数能通过其他函数组合实现，你就不要提供这个函数，让用户自己去实现。
接口清楚
接口包括exported 函数及抽象数据类型
函数
必须显示地让调用者明白接口使用方法及约束：输入参数，输出参数，错误处理，线程是否安全，是否support c++等。
头文件声明时，判断调用者是C++时，加上exern "C"，否則连接错误；
抽象数据类型
一个抽象数据类型是一个接口，它定义了一个数据类型和对该类型的值所进行的操作。一个数据类型是一个值的集合。在C语言中，内建的数据类型包括字符、整数、浮点数等。而结构本身也能定义新的类型，因而可用于建立更高级类型，如列表、树、查找表等。
高级类型是抽象的，因为其接口隐藏了相关的表示细节，并只规定了对该类型值的合法操作。理想情况下，这些操作不会暴露类型的表示细节，因为那样可能使应用程序隐含地依赖于具体的表示。抽象数据类型或ADT的标准范例是栈。
错误处理机制
错误处理返回码应清晰具体，这样便于排查问题。
接口封闭
必须有头有尾，比如你提供了void *context_create();，内部实现malloc一块内存，那么对应的你需要有相应接口释放这块内存空间，比如oid context_destroy(void *ctx)。
可移植性(如果需要)
头文件要做到可移植性，至少看起来你的实现支持windows和linux平台。通过宏来实现。
测试
需要有单元测试，功能测试，稳定性测试及性能测试结果，来保证使用者放心使用。
示例
头文件示例：
#ifndef _NAPI_H_
#define _NAPI_H_
#include
#define ERR_API_BASE 0x00000100
#define ERR_API_INPUT (ERR_API_BASE+0x01)
#if defined(VSAPICALLMCRO) && defined(_WIN32)
#define APICALL __declspec(dllexport)
#else
#define APICALL
#endif
#ifdef__cplusplus
extern"C" {
#endif
APICALL void loglevel_set(uint32_t level);
APICALL void *context_create();
APICALL void context_destroy(void *ctx);
#ifdef__cplusplus
}
#endif
#endif
接口示例：
NAME
rand, rand_r -- random number generator
SYNOPSIS
#include
int rand(void);
int rand_r(unsigned *seed);
DESCRIPTION
These interfaces are obsoleted by arc4random(3).
The rand() function computes a sequence of pseudo-random integers in the range of 0 to RAND_MAX (as defined by the header file
). The rand_r() function provides the same functionality as rand(). A pointer to the context value seed must be supplied by the caller.
高级进阶
依赖
特指编译依赖。若x.h包含了y.h，则称作x依赖y。依赖关系会进行传导，如x.h包含y.h，而y.h又包含了z.h，则x通过y依赖了z。依赖将导致编译时间的上升。虽然依赖是不可避免的，也是必须的，但是不良的设计会导致整个系统的依赖关系无比复杂，使得任意一个文件的修改都要重新编译整个系统，导致编译时间巨幅上升。
在一个设计良好的系统中， 修改一个文件，只需要重新编译数个，甚至是一个文件。
《 google C++ Style Guide》 1.2 头文件依赖 章节也给出了类似的阐述：
若包含了头文件aa.h，则就引入了新的依赖：
一旦aa.h被修改，任何直接和间接包含aa.h代码都会被重新编译。如果aa.h又包含了其他头文件如bb.h，那么bb.h的任何改变都将导致所有包含了aa.h的代码被重新编译，在敏捷开发方式下，代码会被频繁构建，漫长的编译时间将极大的阻碍频繁构建。因此，我们倾向于减少包含头文件，尤其是在头文件中包含头文件，以控制改动代码后的编译时间。
合理的头文件划分体现了系统设计的思想，但是从编程规范的角度看，仍然有一些通用的方法，用来合理规划头文件。本章节介绍的一些方法，对于合理规划头文件会有一定的帮助。
原则1.1 头文件中适合放置接口的声明，不适合放置实现。
说明： 头文件是模块（ Module）或单元（ Unit）的对外接口。头文件中应放置对外部的声明，如对外提供的函数声明、宏定义、类型定义等。
内部使用的函数（相当于类的私有方法）声明不应放在头文件中。
内部使用的宏、枚举、结构定义不应放入头文件中。
变量定义不应放在头文件中，应放在.c文件中。
变量的声明尽量不要放在头文件中，亦即尽量不要使用全局变量作为接口。变量是模块或单元的内部实现细节，不应通过在头文件中声明的方式直接暴露给外部，应通过函数接口的方式进行对外暴露。 即使必须使用全局变量，也只应当在.c中定义全局变量，在.h中仅声明变量为全局的。
原则1.2 头文件应当职责单一。
说明：头文件过于复杂，依赖过于复杂是导致编译时间过长的主要原因。 很多现有代码中头文件过大，职责过多， 再加上循环依赖的问题，可能导致为了在.c中使用一个宏，而包含十几个头文件。
某个头文件不但定义了基本数据类型WORD，还包含了stdio.h syslib.h等等不常用的头文件。如果工程中有10000个源文件，而其中100个源文件使用了stdio.h的printf，由于上述头文件的职责过于庞大，而WORD又是每一个文件必须包含的，从而导致stdio.h/syslib.h等可能被不必要的展开了9900次，大大增加了工程的编译时间。
原则1.3 头文件应向稳定的方向包含。
说明： 头文件的包含关系是一种依赖，一般来说，应当让不稳定的模块依赖稳定的模块，从而当不稳定的模块发生变化时，不会影响（编译）稳定的模块。
就我们的产品来说，依赖的方向应该是： 产品依赖于平台，平台依赖于标准库。 某产品线平台的代码中已经包含了产品的头文件，导致平台无法单独编译、发布和测试， 是一个非常糟糕的反例。
除了不稳定的模块依赖于稳定的模块外，更好的方式是两个模块共同依赖于接口，这样任何一个模块的内部实现更改都不需要重新编译另外一个模块。在这里，我们假设接口本身是最稳定的。
规则1.1 每一个.c文件应有一个同名.h文件，用于声明需要对外公开的接口。
说明： 如果一个.c文件不需要对外公布任何接口，则其就不应当存在，除非它是程序的入口，如main函数所在的文件。
现有某些产品中，习惯一个.c文件对应两个头文件，一个用于存放对外公开的接口，一个用于存放内部需要用到的定义、声明等，以控制.c文件的代码行数。编者不提倡这种风格。这种风格的根源在于源文件过大，应首先考虑拆分.c文件，使之不至于太大。另外，一旦把私有定义、声明放到独立的头文件中，就无法从技术上避免别人include之，难以保证这些定义最后真的只是私有的。
本规则反过来并不一定成立。有些特别简单的头文件，如命令ID定义头文件，不需要有对应的.c存在。
示例：对于如下场景，如在一个.c中存在函数调用关系：
void foo()
{
bar();
}
void bar()
{
Do something;
}
必须在foo之前声明bar，否则会导致编译错误。
这一类的函数声明，应当在.c的头部声明，并声明为static的，如下：
static void bar();
void foo()
{
bar();
}
void bar()
{
Do something;
}
规则1.2 禁止头文件循环依赖。
说明： 头文件循环依赖，指a.h包含b.h， b.h包含c.h， c.h包含a.h之类导致任何一个头文件修改，都导致所有包含了a.h/b.h/c.h的代码全部重新编译一遍。而如果是单向依赖，如a.h包含b.h， b.h包含c.h，而c.h不包含任何头文件，则修改a.h不会导致包含了b.h/c.h的源代码重新编译。
规则1.3 .c/.h文件禁止包含用不到的头文件。
说明： 很多系统中头文件包含关系复杂，开发人员为了省事起见，可能不会去一一钻研，直接包含一切想到的头文件，甚至有些产品干脆发布了一个god.h，其中包含了所有头文件，然后发布给各个项目组使用，这种只图一时省事的做法，导致整个系统的编译时间进一步恶化，并对后来人的维护造成了巨大的麻烦。
规则1.4 头文件应当自包含。
说明： 简单的说，自包含就是任意一个头文件均可独立编译。 如果一个文件包含某个头文件，还要包含另外一个头文件才能工作的话，就会增加交流障碍，给这个头文件的用户增添不必要的负担。
示例：
如果a.h不是自包含的，需要包含b.h才能编译，会带来的危害：
每个使用a.h头文件的.c文件，为了让引入的a.h的内容编译通过，都要包含额外的头文件b.h。
额外的头文件b.h必须在a.h之前进行包含，这在包含顺序上产生了依赖。
注意：该规则需要与“ .c/.h文件禁止包含用不到的头文件”规则一起使用，不能为了让a.h自包含，而在a.h中包含不必要的头文件。 a.h要刚刚可以自包含，不能在a.h中多包含任何满足自包含之外的其他头文件。
规则1.5 总是编写内部#include保护符（ #define 保护） 。
说明：多次包含一个头文件可以通过认真的设计来避免。如果不能做到这一点，就需要采取阻止头文件内容被包含多于一次的机制。
通常的手段是为每个文件配置一个宏，当头文件第一次被包含时就定义这个宏，并在头文件被再次包含时使用它以排除文件内容。
所有头文件都应当使用#define 防止头文件被多重包含，命名格式为FILENAME_H，为了保证唯一性，更好的命名是PROJECTNAME_PATH_FILENAME_H。
注：没有在宏最前面加上““，即使用FILENAME_H代替_FILENAME_H，是因为一般以”“和”_“开头的标识符为系统保留或者标准库使用，在有些静态检查工具中，若全局可见的标识符以”_”开头会给出告警。
定义包含保护符时，应该遵守如下规则：
1）保护符使用唯一名称；
2）不要在受保护部分的前后放置代码或者注释。
示例：假定VOS工程的timer模块的timer.h，其目录为VOS/include/timer/timer.h,应按如下方式保护：
#ifndef VOS_INCLUDE_TIMER_TIMER_H
#define VOS_INCLUDE_TIMER_TIMER_H
...
#endif
也可以使用如下简单方式保护:
#ifndef TIMER_H
#define TIMER_H
..
#endif
例外情况：头文件的版权声明部分以及头文件的整体注释部分（如阐述此头文件的开发背景、使用注意事项等）可以放在保护符(#ifndef XX_H)前面。
规则1.6 禁止在头文件中定义变量。
说明： 在头文件中定义变量，将会由于头文件被其他.c文件包含而导致变量重复定义。
规则1.7 只能通过包含头文件的方式使用其他.c提供的接口，禁止在.c中通过extern的方式使用外部函数接口、变量。
说明：若a.c使用了b.c定义的foo()函数，则应当在b.h中声明extern int foo(int input)；并在a.c中通过#include 来使用foo。禁止通过在a.c中直接写extern int foo(int input);来使用foo，后面这种写法容易在foo改变时可能导致声明和定义不一致。
规则1.8 禁止在extern “C”中包含头文件。
说明：在extern “C”中包含头文件， 会导致extern “C”嵌套， Visual Studio对extern “C”嵌套层次有限制，嵌套层次太多会编译错误。
在extern “C”中包含头文件，可能会导致被包含头文件的原有意图遭到破坏。例如，存在a.h和b.h两个头文件：
使用C++预处理器展开b.h，将会得到
extern "C"
{
void foo(int);
void b();
}
按照a.h作者的本意，函数foo是一个C++自由函数，其链接规范为”C++”。但在b.h中，由于#include “a.h”被放到了extern “C” { }的内部，函数foo的链接规范被不正确地更改了。
示例： 错误的使用方式：
extern “C”
{
#include “xxx.h”
...
}
正确的使用方式：
#include “xxx.h”
extern “C”
{
...
}
建议1.1 一个模块通常包含多个.c文件，建议放在同一个目录下，目录名即为模块名。为方便外部使用者，建议每一个模块提供一个.h，文件名为目录名。
说明：需要注意的是，这个.h并不是简单的包含所有内部的.h，它是为了模块使用者的方便，对外整体提供的模块接口。
以Google test（简称GTest）为例， GTest作为一个整体对外提供C++单元测试框架，其1.5版本的gtest工程下有6个源文件和12个头文件。但是它对外只提供一个gtest.h，只要包含gtest.h即可使用GTest提供的所有对外提供的功能，使用者不必关系GTest内部各个文件的关系，即使以后GTest的内部实现改变了，比如把一个源文件c拆成两个源文件，使用者也不必关心，甚至如果对外功能不变，连重新编译都不需要。
对于有些模块，其内部功能相对松散，可能并不一定需要提供这个.h，而是直接提供各个子模块或者.c的头文件。
比如产品普遍使用的VOS，作为一个大模块，其内部有很多子模块，他们之间的关系相对比较松散，就不适合提供一个vos.h。而VOS的子模块，如Memory（仅作举例说明，与实际情况可能有所出入），其内部实现高度内聚，虽然其内部实现可能有多个.c和.h，但是对外只需要提供一个Memory.h声明接口。
建议1.2 如果一个模块包含多个子模块，则建议每一个子模块提供一个对外的.h，文件名为子模块名。
说明：降低接口使用者的编写难度。
建议1.3 头文件不要使用非习惯用法的扩展名，如.inc。
说明：目前很多产品中使用了.inc作为头文件扩展名，这不符合c语言的习惯用法。在使用.inc作为头文件扩展名的产品，习惯上用于标识此头文件为私有头文件。但是从产品的实际代码来看，这一条并没有被遵守，一个.inc文件被多个.c包含比比皆是。本规范不提倡将私有定义单独放在头文件中，具体见 规则1.1。
除此之外，使用.inc还导致source insight、 Visual stduio等IDE工具无法识别其为头文件，导致很多功能不可用，如“跳转到变量定义处”。虽然可以通过配置，强迫IDE识别.inc为头文件，但是有些软件无法配置，如Visual Assist只能识别.h而无法通过配置识别.inc。
建议1.4 同一产品统一包含头文件排列方式。
说明：常见的包含头文件排列方式： 功能块排序、文件名升序、稳定度排序。
以稳定度排序， 建议将不稳定的头文件放在前面，如把产品的头文件放在平台的头文件前面，如下：
相对来说， product.h修改的较为频繁，如果有错误，不必编译platform.h就可以发现product.h的错误，可以部分减少编译时间。