如何在VSCode中配置CMake进行C++跨平台编译开发

夏晨小哥_3114

夏晨小哥_3114

2026-03-27

607人浏览

原创

c_cpp_properties.json 的 includepath 手动配置易与 cmake 实际路径不一致,应启用 cmake_export_compile_commands 并用 cmake tools 生成 compile_commands.json,再配置 c_cpp > configuration provider 为 cmake-tools。

如何在vscode中配置cmake进行c++跨平台编译开发

为什么 c_cpp_properties.json 里 includePath 配了却还报找不到头文件?

VSCode 的 C/C++ 插件(CPT)不读 CMake 的实际构建配置,它只认自己那套 c_cpp_properties.json。你手动写的 includePath 很可能和 CMake 实际生成的路径不一致,尤其在使用 find_package() 或第三方库(如 fmt、OpenCV)时,头文件位置由 CMake 在 configure 阶段动态确定。

正确做法是让 CMake 帮你生成标准的 compile_commands.json,再让 CPT 自动读取:

  • 确保 CMakeLists.txt 中启用了 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)(推荐放在 project() 后面)
  • 运行一次 cmake --build build 或用 VSCode 的 CMake Tools 插件点击 “Build” —— 这会生成 build/compile_commands.json
  • 在 VSCode 设置中打开 C_Cpp > Configuration Provider,选 ms-vscode.cmake-tools(不是默认的 Default)
  • 重启窗口或点击命令面板执行 C/C++: Reset IntelliSense Database

用 CMake Tools 插件时,buildDirectory 和 sourceDirectory 怎么设才不踩坑?

这两个配置直接决定 CMake 命令执行位置和缓存读写路径。设错会导致重复 configure、找不到 CMakeLists.txt、甚至污染源码目录。

典型错误:把 buildDirectory 设成 ${workspaceFolder}/build,但没配 sourceDirectory,结果插件在 build/ 下找 CMakeLists.txt,当然失败。

  • sourceDirectory 必须指向含 CMakeLists.txt 的目录,比如 ${workspaceFolder} 或 ${workspaceFolder}/src
  • buildDirectory 推荐用绝对路径变量,例如 ${workspaceFolder}/build/${buildType}-${platform},避免多配置冲突
  • Windows 上注意路径分隔符:VSCode 内部统一用 /,别写 \,否则 CMake Tools 可能解析失败
  • 如果项目有多个 CMakeLists.txt(如子模块),必须在设置里指定 cmake.configureSettings 中的 CMAKE_SOURCE_DIR,否则插件会乱猜

跨平台编译时,toolchain file 和 kit 到底谁管什么?

kit 是 CMake Tools 里的“工具链抽象”,它描述“用哪套编译器+环境”,而 toolchain file 是 CMake 原生命令行参数 -DCMAKE_TOOLCHAIN_FILE=...,用于交叉编译(如编译 ARM Linux 或 Android)。两者不等价,也不能互相替代。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

常见混淆:以为选了个 ARM GCC 10.2.1 的 kit 就能自动交叉编译 —— 实际上 kit 只负责调用本地 arm-linux-gnueabihf-gcc,但 CMake 仍按 host 系统生成构建逻辑,缺少 toolchain file 会导致 find_package 找 host 库、target_compile_options 不生效等问题。

  • 交叉编译必配 toolchain file:在 settings.json 中加 "cmake.configureArgs": ["-DCMAKE_TOOLCHAIN_FILE=/path/to/arm-toolchain.cmake"]
  • kit 仅需匹配 toolchain file 里指定的编译器路径(比如 CC 指向 /opt/gcc-arm/bin/arm-linux-gnueabihf-gcc)
  • macOS 编译 iOS?toolchain file 必须含 set(CMAKE_SYSTEM_NAME iOS) 和 set(CMAKE_OSX_ARCHITECTURES "arm64"),kit 选 Xcode 或 clang 即可

cmake.buildArgs 和 cmake.configureArgs 改哪个才生效?

configure 阶段决定构建系统怎么生成(Makefile/Ninja/Visual Studio),build 阶段只是执行已生成的构建命令。绝大多数跨平台适配逻辑(如架构、标准库、链接选项)必须在 configure 阶段传入,build 阶段改参数基本无效。

典型误操作:在 cmake.buildArgs 里加 -j8 没问题,但加 -DENABLE_CUDA=ON 就完全不生效 —— 因为 CMake 已经 configure 完了,ENABLE_CUDA 变量根本没被读取。

  • cmake.configureArgs:放所有 -Dxxx=yyy、-G(生成器)、-DCMAKE_TOOLCHAIN_FILE、-DCMAKE_BUILD_TYPE
  • cmake.buildArgs:只放构建器特有参数,如 Ninja 的 -j8、Make 的 -l4、Visual Studio 的 /p:Configuration=Release
  • 修改 configureArgs 后,必须触发重新 configure(右键命令面板 → “CMake: Configure”),不能只点 “Build”

最常被忽略的是 configure 缓存残留:改了 toolchain file 或 configureArgs 后没删 build/CMakeCache.txt,CMake 会复用旧值,导致行为和预期完全不符。

C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!

相关文章

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

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

下载

相关标签:

vscode

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

相关专题

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

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

2023.08.07

2155

5

json是什么
json是什么

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

2023.08.23

3322

1

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

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

2023.10.13

1116

3

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

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

2025.09.10

3819

7

default gateway怎么配置
default gateway怎么配置

配置default gateway的步骤:1、了解网络环境;2、获取路由器IP地址;3、登录路由器管理界面;4、找到并配置WAN口设置;5、配置默认网关;6、保存设置并退出;7、检查网络连接是否正常。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.12.07

357

5

windows查看端口占用情况
windows查看端口占用情况

Windows端口可以认为是计算机与外界通讯交流的出入口。逻辑意义上的端口一般是指TCP/IP协议中的端口,端口号的范围从0到65535,比如用于浏览网页服务的80端口,用于FTP服务的21端口等等。怎么查看windows端口占用情况呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.26

3259

3

查看端口占用情况windows
查看端口占用情况windows

端口占用是指与端口关联的软件占用端口而使得其他应用程序无法使用这些端口,端口占用问题是计算机系统编程领域的一个常见问题,端口占用的根本原因可能是操作系统的一些错误,服务器也可能会出现端口占用问题。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.27

2838

6

windows照片无法显示
windows照片无法显示

当我们尝试打开一张图片时,可能会出现一个错误提示,提示说"Windows照片查看器无法显示此图片,因为计算机上的可用内存不足",本专题为大家提供windows照片无法显示相关的文章,帮助大家解决该问题。

2023.08.01

1488

3

windows查看端口被占用的情况
windows查看端口被占用的情况

windows查看端口被占用的情况的方法:1、使用Windows自带的资源监视器;2、使用命令提示符查看端口信息;3、使用任务管理器查看占用端口的进程。本专题为大家提供windows查看端口被占用的情况的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2599

5

热门下载

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

精品课程

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