0

0

如何为c++项目配置compile_commands.json以获得更好的工具支持? (Clangd/Clang-Tidy)

尼克

尼克

发布时间:2026-01-13 08:42:33

|

413人浏览过

|

来源于php中文网

原创

启用Clangd等工具需先生成compile_commands.json:CMake项目应在构建目录运行cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON;非CMake项目可用bear拦截编译命令;文件须为合法JSON、directory为绝对路径且Clangd按父目录逐级查找。

如何为c++项目配置compile_commands.json以获得更好的工具支持? (clangd/clang-tidy)

直接生成 compile_commands.json 是启用 Clangd、Clang-Tidy 等工具的前提,但多数 C++ 项目默认不生成它——必须通过构建系统显式开启。

用 CMake 生成 compile_commands.json 的正确方式

CMake 是目前最主流的支持途径,关键不是“能不能”,而是“怎么开才真正生效”。很多用户执行了 cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON 却发现文件没出现,往往是因为没在构建目录里运行,或用了 Ninja/Make 混淆了路径。

  • 必须在 构建目录(build dir) 中运行 CMake 配置命令,而不是源码根目录
  • cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -G "Ninja" ..cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..(后者依赖默认 generator)
  • 生成后,compile_commands.json 会出现在构建目录顶层,不是源码目录
  • 如果用 VS Code + CMake Tools 插件,需确保其“构建目录”设置与你手动配置的一致,否则插件可能读不到该文件

非 CMake 项目:手动构造或用 bear 拦截编译命令

对于 Makefile、autotools 或手写 build.sh 的项目,CMake 参数无效。此时不能靠改配置,得靠“捕获”真实编译过程。

  • bear 是最轻量可靠的方案:先装 bear(如 apt install bearbrew install bear),再用它包裹构建命令:bear -- makebear -- cmake --build .
  • 注意:bear 依赖 gcc/clang 的 wrapper 行为,若项目用 g++-12 或自定义编译器路径,需提前设好 CC/CXX 环境变量
  • 手动写 compile_commands.json 极易出错(比如 directory 字段路径不对、arguments 缺少 -I 或宏定义),不推荐

Clangd 读不到 compile_commands.json 的常见原因

即使文件存在,Clangd 仍可能 fallback 到简易解析,导致跳转不准、宏不展开、头文件找不到——这不是 Clangd 问题,而是路径或内容不匹配。

PaperFake
PaperFake

AI写论文

下载

立即学习C++免费学习笔记(深入)”;

  • Clangd 默认只在当前打开文件的**父目录向上逐级查找** compile_commands.json,不会自动扫描子目录或符号链接外的路径
  • directory 字段必须是绝对路径,且指向实际执行编译命令的工作目录(否则 -I relative/path 会解析失败)
  • 如果项目含子模块(submodule)或外部依赖(如 third_party/),确保这些路径在 arguments 中以 -I-isystem 正确声明,Clangd 不会自动推断
  • VS Code 中,确认 "clangd.arguments" 设置没覆盖掉自动检测,例如删掉 --compile-commands-dir=... 这类硬编码路径
[
  {
    "directory": "/home/user/project/build",
    "command": "/usr/bin/clang++ -I../include -DDEBUG -std=c++20 -c ../src/main.cpp",
    "file": "../src/main.cpp"
  }
]

路径不一致、字段名拼错(比如写成 cmd 而非 command)、JSON 格式非法(末尾多逗号、中文引号),都会让整个文件被忽略——Clangd 不报错,只静默降级。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

549

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

337

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

25

2026.03.13

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

44

2026.03.12

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

177

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

50

2026.03.10

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

92

2026.03.09

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 10.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号