使用compile_commands.json配置includePath环境,解决vscode中引入头文件处有波浪线的问题

通过编译时生成的 compile_commands.json 文件自动完成对 vscode 中头文件路径的配置,实现 vscode 中的代码的自动跳转。完成头文件路径配置后,可以避免代码头部导入头文件部分出现波浪线,警告说无法正确找到头文件。

步骤

  1. 需要在 vscode 中安装 C++ 和 CMake Tools 扩展插件;
  1. 使用下述命令重新编译代码;
shell 复制代码
catkin_make -DCMAKE_BUILD_TYPE=Release -DCMAKE_EXPORT_COMPILE_COMMANDS=Yes

这将会导出一个编译命令文件 compile_commands.json,这可以帮助 vscode 确定代码架构。该配置文件的的生成目录在工作空间的 build 文件夹下。

重新用 vscode 打开项目,可以看见在 .vscode 文件夹下生成的 c_cpp_properties.jsonsettings.json 文件。其中 c_cpp_properties.json 文件中的 includePath 参数中的头文件路径已经自动配置完成。

注意: 如果原先 .vscode 文件夹已经存在 c_cpp_properties.jsonsettings.json 文件的话,需要先手动删除,我测试的时候,好像不会覆盖重新生成,从而导致头文件路径无法自动添加。

此时,文件头部的波浪线已经消失了。如果没有,需要关闭该文件页面,然后重新打开。波浪线消失前后对比效果如下。

  1. 在文件 c_cpp_properties.json 中添加 compileCommands 选项;

也可以将 includePath 参数中的头文件路径全部删除,然后额外添加一个 compileCommands 参数,来指定生成的compile_commands.json 文件的位置,这也能够实现相同的效果。

shell 复制代码
"compileCommands": "${workspaceFolder}/build/compile_commands.json"

两种参数添加方式概览

这两部分内容,保留其一就好。同时,保留也没啥问题。

补充

在文件 c_cpp_properties.json 添加的路径,仅仅是用于 vscode 跳转显示用的,与代码编译过程无关。见参考链接 2

参考

1 vscode使用compile_commands.json配置includePath环境

2 VSCode改了include path仍找不到头文件是为什么? - Latria的回答 - 知乎

相关推荐
稷下元歌16 小时前
7天学会plc加机器视觉关于运动控制部份,配套视频在bib
开发语言·c++·git·vscode·python·docker·pip
仰望星空的凡人1 天前
VSCODE接入Claude Code使用第三方模型教程
ide·vscode·ai智能体·claude code
yongridada2 天前
公司内网使用Vscode+claude code
vscode·claude code
阿林爱吃大米饭2 天前
VSCode Remote SSH 内网服务器使用Codex插件 + Codex跨Provider历史会话迁移完整教程
服务器·vscode·ssh
高级打杂工程师-伍六六2 天前
想随时随地做点自己的事?创建一台VSCode登录的云电脑
人工智能·vscode
2023自学中2 天前
Linux虚拟机,VSCode + GDB 调试配置:launch.json 模板
linux·vscode·嵌入式
维度攻城狮2 天前
vscode使用SSH远程控制时显示远程主机运行的软件界面
vscode·ssh
棒棒的唐2 天前
Vscode Continue插件 集成 本地llama.cpp大模型实现代码补全
ide·vscode·编辑器
养肥胖虎2 天前
多Agent开发笔记:为什么4个Codex加1个Claude会把cpu跑满
vscode·agent·codex
bush42 天前
vscode编辑设备树插件 devicetree LSP
ide·vscode·里氏替换原则