Windows客户端C/C++编程规范“建议”——文件

C++头文件管理最佳实践

最新推荐文章于 2021-05-29 14:32:07 发布

原创最新推荐文章于 2021-05-29 14:32:07 发布 · 2.4k 阅读

CC 4.0 BY-SA版权

文章标签：

36 篇文章

订阅专栏

本文详细介绍了C++头文件管理的关键要点，包括正确使用`#include`、避免重复引用头文件、控制全局变量、设定合理的引用顺序、减少依赖等，旨在提高代码质量和编译效率。

等级：【推荐】

说明：#include <>和#include “”导致编译器在搜索文件时，搜索的路径顺序不同。所以需要正确使用#include，以避免包含错了头文件。

语法形式	操作
带引号的形式	预处理器按以下顺序搜索包含文件：在包含 #include 语句的文件所在的同一目录中。在当前打开的包含文件的目录中，采用与打开它们的顺序相反的顺序。搜索从父包含文件的目录中开始进行，然后继续向上到任何祖父包含文件的目录。跟随每个 /I 编译器选项指定的路径。跟随 INCLUDE 环境变量指定的路径。
尖括号形式	预处理器按以下顺序搜索包含文件：跟随每个 /I 编译器选项指定的路径。通过命令行进行编译时，跟随 INCLUDE 环境变量指定的路径。

等级：【必须】
说明：不可避免的头文件引用存在交叉的场景，所以在定义头文件时，使用域控制等方法控制重复引用问题。
例子：

#pragma once
// 头文件实际内容

或

#ifndef PATH_XXX_HEADER_H
#define PATH_XXX_HEADER_H
// 头文件实际内容
#endif

对于使用#define方式确保头文件不会被重复包含，需要考虑定义的宏名称的唯一性。推荐使用“文件路径”+“_”+“文件名”的方式。比如trunk/core/src/filecheck.h的宏为TRUNK_CORE_SRC_FILECHECK_H。

等级：【要求】
说明：减少代码膨胀。

等级：【推荐】
说明：按如下顺序布局头文件：

等级：【推荐】

说明：通过前置声明的方法替代include文件头的方式，可以减少头文件依赖。这对编译速度有提升。