CMake项目跨目录引用头文件配置问题求助

我正在通过实验学习CMake，创建了一个测试项目巩固知识，但遇到了跨目录头文件引用的问题。项目结构如下：

├── bin
├── CMakeLists.txt
└── src
    ├── Configuration
    │   ├── CMakeLists.txt
    │   ├── Test
    │   │   └── TestConfiguration.h
    ├── Array
    │   └── Array.h
    ├── CMakeLists.txt
    ├── Test2
    │   ├── CMakeLists.txt
    │   ├── Test2.cpp
    │   ├── Test2.h
    │   └── Test2-1.h
    ├── Main
    │   ├── CMakeLists.txt
    │   ├── Config.h
    │   └── Main.h
    ├── Test3
    │   ├── CMakeLists.txt
    │   ├── Time.h
    │   ├── Timer 
    │   │   ├── CMakeLists.txt
    │   │   ├── Iterate.h
    │   ├── Run.h
    │   ├── Serial.cmpl.cpp
    │   └── Serial.h
    ├── Smart.h
    ├── Counting.h
    ├── Mute.h
    └── MainTest.h
    └── Utilities
        ├── CMakeLists.txt
        ├── Inform.h
        ├── Settings.h
        ├── Print.h
        └── Const.h

核心问题是：在src/Utilities/Inform.h中使用#include "Main/Config.h"时，编译器找不到该文件，只能通过../../Main/Config.h这种相对路径引用。我尝试过add_library、target_include_directories、target_link_libraries等指令，但始终没解决问题，希望能学会通过CMake配置实现项目内文件的跨目录引用。

另外还有两个疑问：

1. 是否需要同时编辑src/CMakeLists.txt？还是仅编辑子目录的CMakeLists.txt即可？
2. 我使用CMake 3.16.3，开发环境是基于Ubuntu 20.04.1的x86_64 Elementary OS，这些环境信息是否会影响配置？

解决方案 #

1. 顶层CMakeLists.txt配置 #

首先，顶层的CMakeLists.txt需要设置项目基础信息，并指定输出目录到bin：

cmake_minimum_required(VERSION 3.16)
project(CMakeTestProject)

# 指定可执行文件输出到bin目录
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/bin)

# 引入src目录的配置
add_subdirectory(src)

2. src目录CMakeLists.txt配置 #

src/CMakeLists.txt必须负责引入所有子模块，这是顶层CMake识别子目录的关键：

# 引入所有子模块目录
add_subdirectory(Main)
add_subdirectory(Utilities)
add_subdirectory(Configuration)
add_subdirectory(Test2)
add_subdirectory(Test3)

3. src/Utilities/CMakeLists.txt配置 #

创建库目标并设置包含路径，这是解决跨目录引用的核心：

# 创建INTERFACE类型库（无cpp文件时用INTERFACE，有cpp文件用STATIC/SHARED）
add_library(Utilities INTERFACE)

# 设置包含目录：PUBLIC会让依赖该库的目标自动继承这些路径
target_include_directories(Utilities
    PUBLIC
        ${CMAKE_CURRENT_SOURCE_DIR}  # 允许直接引用Utilities自身的头文件
        ${CMAKE_CURRENT_SOURCE_DIR}/..  # 让编译器以src为根目录查找头文件
)

# 如果Utilities依赖Main模块，添加链接（按需启用）
# target_link_libraries(Utilities PUBLIC Main)

4. src/Main/CMakeLists.txt配置 #

同样为Main模块创建库目标并配置路径：

add_library(Main INTERFACE)

target_include_directories(Main
    PUBLIC
        ${CMAKE_CURRENT_SOURCE_DIR}
        ${CMAKE_CURRENT_SOURCE_DIR}/..
)

关键原理说明 #

• target_include_directories的PUBLIC关键字：这是核心，它会将当前目标的包含路径传递给所有依赖该目标的其他模块，确保跨模块引用时路径有效。
• 以src为根目录：把src目录（即子模块中的${CMAKE_CURRENT_SOURCE_DIR}/..）添加为包含路径后，编译器会从src开始查找头文件，#include "Main/Config.h"会被解析为src/Main/Config.h，完全匹配项目结构。
• 可执行文件配置（按需）：如果有入口可执行文件（比如Main模块下的main.cpp），需要创建可执行目标并链接依赖库：

add_executable(MainExecutable main.cpp)
target_link_libraries(MainExecutable PUBLIC Utilities Main)

疑问解答 #

1. 必须编辑src/CMakeLists.txt：顶层CMake通过add_subdirectory(src)引入该目录，而src目录的配置文件需要负责引入所有子模块，仅编辑子目录的CMakeLists.txt无法让顶层CMake识别这些模块。
2. 环境无兼容性问题：CMake 3.16.3完全支持上述配置，Ubuntu 20.04的环境也不会造成影响，无需额外调整。

内容的提问来源于stack exchange，提问作者wolfex