本文假设读者已具备基本的C编译常识。如非非凡阐发白丝 双马尾，文中“源文献”指 * .c文献，“头文献”指 *.h文献，“援用”指包含头文献。

一、头文献作用

C谈话里，每个源文献是一个模块，头文献为使用该模块的用户提供接口。接口指一个功能模块显露给其他模块用以捕快具体功能的门径。

使用源文献结束模块的功能，使用头文献显露单位的接口。用户只需包含相应的头文献就可使用该头文献中显露的接口。

通过火文献包含的门径将设施中的各功能模块操办起来成心于模块化设施遐想：

1）通过火文献调用库功能。在好多场面，源代码未便(或不准)向用户公布，只消向用户提供头文献和二进制库即可。用户只需按照头文献中的接口声明来调用库功能，而无谓暖热接口奈何结束。编译器会从库中提真金不怕火相应的代码。

2）头文献能加强类型安全搜检。若某个接口的结束或使用方式与头文献中的声明不一致，编译器就会指出荒唐。这一浅陋的划定能大大缩小设施员调试、改错的包袱。

在预搞定阶段，编译器将源文献包含的头文献内容复制到包含语句(#include)处。在源文献编译时，连同被包含进来的头文献内容一说念编译，生成缱绻文献(.obj)。

如果所包含的头文献卓绝宽广，则会严重裁汰编译速率(使用GCC的-E选项可取得并检察最终预搞定完的文献)。因此，在源文献中应仅包含必需的头文献，且尽量不要在头文献中包含其它头文献。

二、 头文献组织原则

源文献中结束变量、函数的界说，并指定集会边界。头文献中书写外部需要使用的全局变量、函数声明及数据类型和宏的界说。

建议组织头文献内容时谨守以下原则：

1）头文献鉴别原则：类型界说、宏界说尽量与函数声明相分离，分别位于不同的头文献中。里面函数声明头文献与外部函数声明头文献相分离，里面类型界说头文献与外部类型界说头文献相分离。

把稳，类型和宏界说就怕无法分拆为不同文献，比如结构体内数构成员的元素个数用常量宏默示时。因此仅分离类型宏界说与函数声明，且分别置于*.th和*.fh文献(并非强制要求)。

2）头文献的语义档次化原则：头文献需要有语义档次。不同语义档次的类型界说不要放在一个头文献中，不同档次的函数声明不要放在一个头文献中。

3）头文献的语义联系性原则：消除头文献中出现的类型界说、函数声明应该是语义联系的、有里面逻辑关系的，幸免将无关的界说和声明放在一个头文献中。

4）头文献名应尽量与结束功能的源文献疏浚，即module.c和module.h。但源文献不一定要包含其同名的头文献。

5）头文献中不应包含土产货数据，以裁汰模块间耦合度。

即惟有源文献我方使用的类型、宏界说和变量、函数声明，不应出目下头文献里。作用域限于单文献的独到变量和函数应声明为static，以醒目外部调用。将独到类型置于源文献中，会普及团员度，并减少无谓要的形状外漏。

6）头文献内不允许界说变量和函数，只可有宏、类型(typedef/struct/union/enum等)及变量和函数的声明。

非凡情况下可extern基本类型的全局变量，源文献通过包含该头文献捕快全局变量。但头文献内不应extern自界说类型(如结构体)的全局变量，不然将迫使本不需要捕快该变量的源文献包含自界说类型地点头文献[1]。

色综合

7）阐发性头文献不需要有对应的源文献。此类头文献内大多包含大王人见解性宏界说或陈列类型界说，不包含任何其他类型界说和变量或函数声明。此类头文献也不应包含任何其他头文献。

8）使用#pragma once或header guard(亦称include guard或macro guard)幸免头文献类似包含。#pragma once是一种非圭臬但已被当代编译器世俗复古的手段，它明确奉告预搞定器“不要类似包含刻下头文献”。而header guard则通过预搞定大喊模拟类似行径：

使用#pragma once比拟header guard具有两个优点：

① 更快。编译器不会第二次读取记号#pragma once的文献，但却会读多少遍使用header guard 的文献(寻找#endif)；

② 更浅陋。不再需要为每个文献的header guard取名，幸免宏名重名激励的“找不到声明”问题。

时弊则是：

#pragma once保证物理上的消除个文献不会被包含屡次，无法敌人文献中的一段代码作#pragma once声明。若某个头文献具有多份拷贝(内容疏浚的多个文献)，pragma不成保证它们不被类似包含。虽然，这种类似包含很容易被发现并修正。

9）C++中要援用C函数时，函数地点头文献内应包含extern "C"。

被extern "C"修饰的变量和函数将按照C谈话方式编译和集会，不然编译器将无法找到C函数界说，从而导致集会失败。

10）头文献内要有面向用户的满盈注目，从哄骗角度形色接口显露的内容。

三、 头文献包含原则

在本体编程中，赓续因头文献包含不妥而激励编译时申报记号未界说的荒唐或类似界说的警戒。

要甩掉记号未界说的编译荒唐，只需在援用记号(变量、函数、数据类型及宏等)前确保它已被声明或界说[4]。要甩掉类似界说的警戒，则需合理遐想头文献包含法例和档次。

建议包含头文献时谨守以下原则：

1）源文献内的头文献包含法例应从最非凡到一般，

如：

优点是每个头文献必须include需要的关联头文献，不然会报错。

同期，源文献同名头文献置于包含列表前端便于搜检该头文献是否自完备，以及类型或函数声明是否与圭臬库突破。

2）减少头文献的嵌套和交叉援用，头文献仅包含其信得过需要显式包含的头文献。

举例，头文献A中出现的类型界说在头文献B中，则头文献A应包含头文献B，除此除外的其他头文献不允许包含。

头文献的嵌套和交叉援用会使设施组织结构和文献组织变得参差词语，同期形成潜在的荒唐。大型工程中，原有头文献可能会被多个其他(源或头)文献包含，在原有头文献中添加新的头文献每每牵一发而动全身。若头文献中类型界说需要其他头文献时，可将其提议来单独形成一个全局头文献。

3）头文献应包含哪些头文献仅取决于自己，而非包含该头文献的源文献。

举例，编译源文献时需要用到头文献B，且源文献已包含头文献A，而索性将头文献B包含在头文献A中，这是荒唐的作念法。

4）尽量保证用户使用此头文献时，无需手动包含其他前提头文献，即此头文献内已包含前提头文献。

举例，面积联系操作的头文献Area.h内已包含对于点操作的头文献Point.h，则用户包含Area.h后无需再手动包含Point.h。这么用户就无谓了解头文献的内在依赖关系。

5）头文献应是自完备的，即在职一源文献中包含任一头文献而不会产生编译荒唐。

6）源文献中包含的头文献尽量不要有法例依赖。

7）尽量在源文献中包含头文献，而非在头文献中。且源文献仅包含所需的头文献。

8）头文献中若能前置声明(亦称前向声明[5])，就不要包含另一头文献。仅刻下置声明不成怡悦或过于难堪时才使用include，如斯可减少依赖性方面的问题。

示举例下：

如上，在OmciChkFunc函数的结束源文献内包含T_MeInfoMap和T_OmciMsg地点头文献即可。

另举一举例下：

如上，CompareRecFunc函数原型由其他头文献提供，此处为幸免头文献交叉援用界说其异名同构原型CmpRecFunc。

在不会引起歧义的前提下，头文献内尽可能使用VOID指针代替非基本类型的值变量或指针，以幸免再包含类型界说地点的头文献。但这将影响代码可读性并裁汰设施实际后果，应衡量轻重。

9）幸免包含分量级的平台头文献，如windows.h或d3d9.h等。若仅使用该头文献小数函数，可extern函数到源文献内。如下：

若还使用该头文献某些类型和宏界说，可创建适配性源文献。在该源文献内包含平台头文献，封装新的接口并将其声明在同名头文献内，其他源文献将通过适佳耦文献辗转捕快平台接口。如下：

10）对于函数库(包括圭臬库和自界说的环球宏及接口)的头文献，可将其加入到一个通用头文献中。需要适度该头文献的体积(主如果该头文献所包含的总计头文献内容大小)，并确保总计源文献率先包含该通用头文献。示举例下：

把稳，示例头文献内包含C库文献虽能简化包含，但却与划定1突破。也可另外增多包含库文献列表的通用头文献。

11）若不细目类型、宏界说或函数声明地点头文献具体旅途，可在源文献中再次界说或声明，编译器会以redefined警戒或conflicting荒唐给出类型、宏界说或函数声明地点头文献旅途。

四、代码文献组织原则

建议C谈话名目中代码文献组织谨守以下原则：

1）使用档次化和模块化的软件竖立模子。每个模块只可使用地点层和下一层模块提供的接口。

2）每个模块的文献(可能多个)保存在一个沉着文献夹中。

模块文献较多时可继承子目次的方式，物理上报复不同档次的文献。子目次下源文献和头文献应分开存放，如分别置入include和source目次。

3）用于模块裁减的条款编译宏保存在一个沉着文献中，便于软件裁减。

4）硬件联系代码和操作系统联系代码与工程代码相对沉着保存，以便于软件移植。

5）按疏浚功能或联系性组织源文献和头文献。消除文献内的团员度要高，不同文献中的耦合度要低。

在对既有工程作念单位测试时，耦合度低的文献布局卓绝便于搭建环境。

6）声明和界说分开，使用头文献显露模块需要提供给外部的类型、宏、变量和函数。尽量作念到模块对外部透明，用户在使用模块功能时无需了解具体的结束。

7）行为对外接口的头文献依然发布，应保抓解析。修改时一定要老成。

8）文献夹和文献定名要大致反应出模块的功能。

9）郑再版块和测试版块使用长入文献，使用宏适度是否产生测试输出。

10）必要的注目不可艰巨白丝 双马尾。