使用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的回答 - 知乎

相关推荐
带电的小王6 小时前
VSCode:VSCode安装 -- 最简洁的VSCode安装教程
ide·vscode·编辑器
sg_knight11 小时前
VSCode如何修改默认扩展路径和用户文件夹目录到D盘
前端·ide·vscode·编辑器·web
GPT祖弘12 小时前
【VScode】第三方GPT编程工具-CodeMoss安装教程
ide·vscode·gpt
乐闻x12 小时前
VSCode 插件开发实战(五):实现新语言支持和语法高亮
ide·vscode·编辑器
Dontla12 小时前
vscode怎么设置anaconda python解释器(anaconda解释器、vscode解释器)
ide·vscode·python
乐闻x12 小时前
VSCode 插件开发实战(六):配置自定义状态栏
ide·vscode·编辑器
漫天转悠12 小时前
VScode中配置ESlint+Prettier详细步骤(图文详情)
vscode·vue
张明奇-琦玉12 小时前
vscode添加全局宏定义
ide·vscode·编辑器
SZ17011023112 小时前
银河麒麟 SSH Vscode连接
vscode·ssh·银河麒麟
Code_流苏12 小时前
VSCode搭建Java开发环境 2024保姆级安装教程(Java环境搭建+VSCode安装+运行测试+背景图设置)
java·ide·vscode·搭建·java开发环境