ROS/catkin：如何正确指定含git子模块的包的头文件路径

我来帮你搞定这个头疼的头文件引用问题！结合ROS的catkin构建规则，咱们一步步排查解决：

1. 修正catkin_package的INCLUDE_DIRS配置 #

首先你提到已经在包A的catkin_package里加了INCLUDE_DIRS，但要确保路径指向子模块的根include目录，而不是中间层级。比如你的子模块结构是my-submodule/include/foo/bar.h，那正确的配置应该是：

catkin_package(
  INCLUDE_DIRS include my-submodule/include
  # 其他配置比如LIBRARIES、CATKIN_DEPENDS等按需添加
)

这里的路径是相对于包A根目录的相对路径，my-submodule/include是让依赖包B能直接找到foo/bar.h的关键。

2. 确保包A自身能找到子模块头文件 #

在包A的CMakeLists.txt里，include_directories也需要包含子模块的include路径，这样包A自己编译时不会报错：

include_directories(
  include
  ${catkin_INCLUDE_DIRS}
  my-submodule/include
)

3. 规范代码中的头文件引用方式 #

因为子模块是层级化目录，代码里引用头文件时要使用全局路径，而不是相对路径。比如子模块里的my-submodule/include/foo/bar.h，应该写成：

#include <foo/bar.h>

而不是#include "../my-submodule/include/foo/bar.h"，这样编译器才能通过你配置的INCLUDE_DIRS找到文件。

4. 确认依赖包B的CMake配置正确 #

包B要正确依赖包A，才能继承它暴露的头文件路径：

• 在包B的CMakeLists.txt里添加：

  find_package(catkin REQUIRED COMPONENTS packageA)
  

• 然后在include_directories里包含${catkin_INCLUDE_DIRS}：

  include_directories(
    include
    ${catkin_INCLUDE_DIRS}
  )
  

5. 清理构建缓存重新编译 #

有时候旧的构建缓存会导致路径不生效，建议彻底清理后重新构建：

# 进入catkin工作空间根目录
cd ~/catkin_ws
rm -rf build devel
catkin_make

6. 检查Git子模块是否完整初始化 #

别忘了确认子模块已经拉取了所有文件，在包A的目录下运行：

git submodule update --init --recursive

避免因为子模块文件缺失导致头文件找不到。

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