Clang配置compile_commands.json教程

大伟同学_7805

大伟同学_7805

2026-08-11

473人浏览

原创

必须加该参数,因为cmake默认不生成compile_commands.json;只有启用cmake_export_compile_commands=on后,构建系统才会将每个.cpp文件的实际编译命令(含-i、-d、-std等)写入该文件,供clangd、clang-tidy和vscode精准还原编译上下文,否则将出现头文件找不到、宏未定义、跳转错误等问题。

clang配置compile_commands.json教程

cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON 为什么必须加这个参数

不加它,CMake 就不会把每个 .cpp 文件实际用什么命令、带什么 -I-D-std= 编译,写进 compile_commands.json。Clangd、clang-tidy、vscode 跳转全靠这个文件还原编译上下文,没它就只能瞎猜——结果就是头文件找不到、宏未定义、跳转到错误位置。

常见错误现象:

  • clangd 启动后日志里反复出现 Failed to load compilation database
  • Ctrl+Click 函数名提示 No definition found
  • clang-tidy 报一堆 use of undeclared identifier,明明代码能编译过

实操建议:

  • 必须在 cmake 配置阶段加,不是构建阶段:mkdir build && cd build && cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
  • ON1 都可以,但别写成 True(某些旧版 CMake 会忽略)
  • 生成位置固定在 build 目录下,不是项目根目录;VS Code 默认只认根目录的 compile_commands.json,所以得补一句:ln -s build/compile_commands.json .

bear -- make 为什么有时不生成 compile_commands.json

Bear 不是解析 Makefile,而是靠 LD_PRELOAD 劫持子进程调用的 gccg++clang++。如果构建过程根本没调用这些编译器,它就捕不到任何命令。

典型场景:

  • make 返回 make: Nothing to be done —— clean 没做,缓存导致没真正编译
  • 用了 Ninja(cmake -G Ninja),Bear 对 Ninja 的拦截不稳定,尤其在 macOS 上常失效
  • 编译器被 wrapper 封装(比如 ccache g++ 或自定义脚本),Bear 默认只 hook g++,不识别 wrapper 名

实操建议:

  • make clean,再 bear -- make -j;clean 本身不用加 bear --
  • CMake 项目想用 Bear,显式指定生成器:cmake -G "Unix Makefiles" ..,避免 Ninja
  • 若 wrapper 不可绕过,用 --append + 手动补 command 字段,或改用 CMake 原生方案

compile_commands.json 里 directory 和 command 字段到底影响什么

这两个字段决定 Clangd 能不能正确找到头文件、展开宏、识别标准版本。它们不是装饰,是运行时真实环境的快照。

Social Media Commander
Social Media Commander

全栈社交媒体管理技能,涵盖内容创作、审核、排程、发布、漏斗管理、数据分析、受众洞察、竞争对手分析。

下载

directory 是工作目录,影响所有相对路径(比如 -I../include);command 是完整 shell 命令字符串,Clangd 会按字面解析,包括空格、引号、转义。

容易踩的坑:

  • directory 写错(比如多了一层 build/),会导致 -I./include 变成 build/./include,头文件全挂
  • command 里含 shell 变量(如 $PWD)或管道(|)、重定向(>)——JSON 不支持,Clangd 直接解析失败
  • Windows 上路径分隔符混用(\ vs /),某些版本 clangd 会卡在路径拼接

验证方法:打开 compile_commands.json,找一个你熟悉的 .cpp 条目,复制 command 字符串,在 directory 指向的路径下粘贴执行,看是否真能编译通过。

ROS 2 / colcon 项目怎么让 clangd 识别 /opt/ros/humble/include

colcon 本身不自动导出 compile_commands.json,即使你装了 python3-colcon-json,也得配合 CMake 参数才生效。否则 clangd 根本不知道 ROS 头文件在哪。

关键点:

  • colcon build --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON 必须加,且要放在 --cmake-args 后面,不是全局参数
  • 生成的 compile_commands.jsonbuild/<package_name>/</package_name> 下,不是统一在 workspace/build/;得用 find build -name compile_commands.json | head -n1 定位,再软链到 workspace 根目录
  • 如果仍有头文件报错,检查 command 字段里是否含 -isystem /opt/ros/humble/include;没有的话,说明 CMakeLists.txt 里漏了 ament_target_dependenciesfind_package

不要靠 .clangd 硬加 -I/opt/ros/...:ROS 包之间有依赖传递和接口头文件导出机制,手动加路径会绕过这一层,导致跨包跳转失效。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

2023.06.20

3716

8

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.28

1175

5

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1518

5

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

2023.08.17

9143

11

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

820

4

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2164

5

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.14

1409

5

js截取字符串的方法介绍
js截取字符串的方法介绍

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

2023.09.21

3629

3

js生成随机数方法
js生成随机数方法

JavaScript生成随机数的方法,包括使用Math.random()方法生成指定范围内的随机整数、生成随机字符串和生成随机颜色。根据具体需求,可以选择适合的方法来生成随机数,以实现各种功能 。

2023.09.25

1995

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Libclang tutorial
Libclang tutorial

共0课时 | 0人学习