VS Code CMake 快速入门:从零创建 C++ HelloWorld 项目(官方文档翻译+实操)

开发板推荐:天空星STM32F407VET6开发板

超高性价比 STM32主控 | 超高主频 | 一板兼容百芯 | 比赛神器 | 沉金彩色丝印

VS Code CMake 快速入门:从零创建 C++ HelloWorld 项目(官方文档翻译+实操)

📌 本文基于 VS Code 官方文档 CMake Quick Start 完整翻译+实操优化,详细讲解如何在 VS Code 中,借助 CMake Tools 扩展从零创建一个可直接编译、运行的 CMake HelloWorld 项目,全程可视化操作,无需手动编写复杂配置,新手可直接跟着操作!
💡 前置说明:需提前安装 VS Code、C/C++ 扩展、CMake Tools 扩展(若未安装,可参考文末小贴士)。
✨ 特殊说明:如果你的项目根目录已经存在 CMakeLists.txt 文件,但缺少 CMake 预设配置,可直接跳转到 三、创建 CMakePresets.json 文件 章节,快速完成项目配置。

一、新建项目文件夹(实操第一步)

首先打开系统终端(Windows 用 PowerShell/CMD,Linux/macOS 用终端),执行以下命令,创建项目文件夹并启动 VS Code:

mkdir helloworld
cd helloworld
code .

📝 说明:code . 命令会在当前工作目录(helloworld 文件夹)启动 VS Code,该目录即为本次项目的「工作区(Workspace)」,所有项目文件都会保存在这里。

二、创建 CMakeLists.txt 文件(核心配置文件)

CMake Tools 扩展可自动生成基础 CMake 项目所需文件,无需手动编写,步骤如下:

  1. 打开 VS Code 「命令面板」(快捷键:Windows/Linux Ctrl+Shift+P;macOS ⇧⌘P);
  2. 在命令面板中输入并执行命令:CMake: Quick Start
    在这里插入图片描述
  3. 输入项目名称(例如 helloworld),回车后选择 C++ 作为项目语言;
  4. 可选扩展(按需选择,新手建议选 CTest):
    • 选择 CTest:为项目添加单元测试支持;
    • 选择 CPack:为项目添加打包支持(后续可打包成可执行程序);
  5. 选择项目类型:Executable(可执行程序)
    • Executable:生成带有 main() 函数的可执行文件(本次教程首选);
    • Library:生成库文件(包含源文件与头文件,适合开发组件/工具库);

✅ 执行完成后,VS Code 会自动生成两个核心文件,同时会生成一个build文件夹:

  • CMakeLists.txt:CMake 核心配置文件,告诉 CMake 如何构建项目;
  • main.cpp:项目主源码文件,包含默认的 HelloWorld 输出代码。
    在这里插入图片描述

注意事项(新手必看)

  • 若 helloworld 文件夹内已有其他源码文件,扩展会提示「是否将这些文件加入构建目标」,本教程直接选择「否」,保留默认的 HelloWorld 文件即可;

  • 若弹出「允许配置文件夹 IntelliSense」的提示,务必选择 Allow(允许),否则会影响代码补全和语法检查。

三、创建 CMakePresets.json 文件(统一配置预设)

完成 CMakeLists.txt 创建后,继续在 CMake Quick Start 流程中,生成 CMake 预设文件(用于统一管理构建配置,跨平台、跨 IDE 可共享),步骤如下:

  1. 在弹出的引导窗口中,选择 Add a New Preset(添加新预设)
  2. 选择 Create from Compilers(从编译器创建)
    在这里插入图片描述
  3. 扩展会自动扫描系统中已安装的编译器(如 GCC、Clang、MSVC),并列出所有可选工具链;
  4. 选择你要使用的编译器(新手推荐选择系统默认编译器,例如 Windows 选 MSVC,Linux 选 GCC,macOS 选 Clang);
  5. 为当前预设输入一个名称(例如 mypresentgcc-debug,便于后续区分配置)。

✅ 完成后,项目根目录会新增 CMakePresets.json 文件,至此,一个完整的 CMake C++ HelloWorld 项目就创建完成了!
在这里插入图片描述

四、项目文件结构(清晰易懂)

创建完成后,项目文件夹结构如下(可在 VS Code 左侧「资源管理器」中查看):

helloworld/
├── CMakeLists.txt  # CMake 核心配置文件
├── CMakePresets.json  # 构建配置预设文件
└── main.cpp  # 主源码文件

五、后续操作(构建+调试,新手必看)

项目创建完成后,只需3步即可完成构建和调试,全程可视化操作:

  1. 配置项目:打开命令面板,执行 CMake: Configure,或者点击CMakeTool工具「配置」按钮,CMake 会自动生成构建文件(在 out/build 目录下);
    在这里插入图片描述

  2. 构建项目:打开命令面板,执行 CMake: Build,或点击 VS Code 状态栏底部左侧的「Build」按钮(齿轮图标);
    在这里插入图片描述

  3. 调试/运行:打开 main.cpp,在 std::cout 行左侧点击添加断点(小红点),然后执行 CMake: Debug 或按 F5 启动调试,调试器会在断点处暂停,按 F5 可继续运行。直接运行的话点击左下角三角形按钮。

六、常见问题小贴士(CSDN 专属补充)

  • ❓ 提示「找不到 CMake 工具」:检查是否安装 CMake(建议 3.27 及以上版本),并配置环境变量,如果没有可以安装官方版本cmake-4.2.3-windows-x86-64

  • ❓ 扩展安装失败:重启 VS Code,在扩展面板搜索「C/C++」「CMake Tools」,选择微软官方版本安装;
    在这里插入图片描述

在这里插入图片描述

  • ❓ 构建失败:检查编译器是否安装正确,或重新执行「CMake: Configure」,确保配置无误。

八、总结

VS Code 的 CMake: Quick Start 功能极大简化了 CMake 项目的创建流程,新手无需掌握复杂的 CMake 语法,只需几步点击,就能自动生成所有核心配置文件和示例源码,高效便捷。

✨ 结尾福利:如果觉得本文对你有帮助,欢迎点赞+收藏+关注,后续会持续更新 VS Code CMake 进阶教程!

(注:文档部分内容可能由 AI 生成)

开发板推荐:天空星STM32F407VET6开发板

超高性价比 STM32主控 | 超高主频 | 一板兼容百芯 | 比赛神器 | 沉金彩色丝印

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值