解决VS Code下找不到ROS头文件和无法自动补全的问题

环境

  1. Ubuntu 18.04
  2. VS Code 插件: C/C++
  3. ROS Melodic
  4. gcc, clang(可选)

工作目录

项目myproject文件夹位于~/catkin_ws/src/myproject, 关于ROS catkin_ws工作空间的创建可以参考这里.

步骤

1. 构建并导出编译命令
  1. 确保当前.cpp源文件已被添加到项目文件夹下的CMakeLists.txt中,例如:

add_executable(node_name src/main.cpp)

如果有其它自定义头文件路径也可以一并设置,没有的可以略过(注意ROS头文件所在路径不需要在这里指定):

target_include_directories(node_name PUBLIC ${PROJECT_SOURCE_DIR}/include)

  1. ~/catkin_ws/src/myproject下执行下列命令导出编译命令(myproject需要修改为自己的项目名,或者删掉,构建catkin_ws下的所有项目。

catkin build [myproject] -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

或者,将set(CMAKE_EXPORT_COMPILE_COMMANDS ON)加入到自己项目文件的CMakeLists.txt文件中,然后执行,这样在每次构建时都会自动导出编译命令。

catkin build [myproject]

构建完成后,在~/catkin_ws/build/myproject/下会生成一个compile_commands.json文件,这个文件可以用来实现代码的自动补全功能.

2. VS Code 设置

在VS Code中 按下Ctrl+Shift+P打开主命令框,输入 C/C++: Edit configurations (UI),打开配置C/C++的UI界面。滚到最下方,展开Advanced Settings,在Compile command设置中输入如下内容(myproject需要修改成工程文件夹名,或者直接输入上一步生成的compile_commands.json文件的绝对路径):

${workspaceFolder}/../../build/[myproject]/compile_commands.json

Screenshot from 2020-08-22 22-04-00.png
3. 重启VS Code

重启VS Code,或者Ctrl+Shift+P打开主命令框输入 Developer: Reload Window

4. 效果

最终效果如下,可以看到头文件可以被找到,并且可以给出自动补全。(如果这一步仍然提示找不到头文件,但是可以实现自动补全,检查一下是否有其它C++插件在工作,例如clangd, C++ Intellisense 等)


Screenshot from 2020-08-22 23-36-00.png

使用Clang提供自动补全(可选)

Clang编译器提供的自动补全功能一般更友好一些,比如,如果上述步骤默认采用gcc编译器,ROS_INFO仍存在警告提示,而且不能自动补全Ros::Rate等一些类,而Clang没有这些问题。使用Clang编译器的配置如下:


Screenshot from 2020-08-22 23-39-20.png

上面文件可以 Ctrl + Shift +P 输入C/C++: Edit configurations (JSON)打开,注意这个文件和之前使用的C/C++: Edit configurations (UI) 是自动同步的,修改一处即可。
没有安装Clang的话需要sudo apt install clang
注意:这些设置只保证自动补全功能使用Clang编译器,不会影响最终编译时候所选择的编译器。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 225,132评论 6 523
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 96,457评论 3 404
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 172,411评论 0 368
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 61,147评论 1 301
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 70,145评论 6 400
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 53,611评论 1 315
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,962评论 3 429
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,948评论 0 279
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 47,479评论 1 324
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 39,514评论 3 347
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 41,640评论 1 355
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,228评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,973评论 3 340
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,402评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,551评论 1 277
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 50,210评论 3 381
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 46,714评论 2 366