🚀 在 VS Code 中！

配置 VS Code 以使用 Microsoft C++

在本教程中，你将配置 Visual Studio Code 以在 Windows 上使用 Microsoft Visual C++ 编译器和调试器。

配置 VS Code 后，你将在 VS Code 中编译和调试一个简单的 Hello World 程序。本教程不教授有关 Microsoft C++ 工具集或 C++ 语言的详细信息。关于这些主题，Web 上有很多优秀的资源。

如果你有任何问题，请随时在 VS Code 文档存储库 中为此教程提交问题。

准备工作

要成功完成本教程，你必须执行以下操作

  1. 安装 Visual Studio Code。

  2. 安装 VS Code 的 C/C++ 扩展。你可以通过在扩展视图中搜索 'c++' 来安装 C/C++ 扩展 (⇧⌘X (Windows, Linux Ctrl+Shift+X))。

    C/C++ extension

  3. 安装 Microsoft Visual C++ (MSVC) 编译器工具集。

    如果你安装了最新版本的 Visual Studio，请从 Windows “开始” 菜单打开 Visual Studio Installer，并验证是否已选中 C++ 工作负载。如果未安装，请选中该复选框，然后在安装程序中选择“修改”按钮。

    你也可以在不安装完整 Visual Studio IDE 的情况下安装“使用 C++ 的桌面开发”工作负载。从 Visual Studio 下载 页面，向下滚动直到在“所有下载”部分下看到“Visual Studio 工具”，然后选择“Visual Studio 2022 的生成工具”的下载。

    Build Tools for Visual Studio download

    这将启动 Visual Studio Installer，它将弹出一个对话框，显示可用的 Visual Studio 生成工具工作负载。选中“使用 C++ 的桌面开发”工作负载，然后选择“安装”。

    Cpp build tools workload

注意：只要你还拥有有效的 Visual Studio 许可证（Community、Pro 或 Enterprise），并积极用于开发该 C++ 代码库，就可以将 Visual Studio Build Tools 中的 C++ 工具集与 Visual Studio Code 一起使用，以编译、构建和验证任何 C++ 代码库。

检查你的 Microsoft Visual C++ 安装

要从命令行或 VS Code 使用 MSVC，你必须从 Visual Studio 的 Developer Command Prompt 运行。普通的 shell（例如 PowerShell、Bash 或 Windows 命令提示符）未设置必要的路径环境变量。

要打开 Visual Studio 的 Developer Command Prompt，请在 Windows “开始” 菜单中开始键入“developer”，你应该会在建议列表中看到它。确切的名称取决于你安装的 Visual Studio 或 Visual Studio Build Tools 的版本。选择该项以打开提示符。

Developer Command Prompt

你可以通过键入 'cl' 来测试你是否正确安装了 C++ 编译器 cl.exe，你应该会看到一条版权消息，其中包含版本和基本用法描述。

Checking cl.exe installation

如果 Developer Command Prompt 使用 BuildTools 位置作为起始目录（你不会想把项目放在那里），请在开始创建新项目之前导航到你的用户文件夹 (C:\users\{your username}\)。

注意：如果由于某种原因你无法从 Developer Command Prompt 运行 VS Code，你可以在 在 Developer Command Prompt 之外运行 VS Code 中找到使用 VS Code 构建 C++ 项目的解决方法。

创建 Hello World

从 Developer Command Prompt 中，创建一个名为 “projects” 的空文件夹，你可以在其中存储所有 VS Code 项目，然后创建一个名为 “helloworld” 的子文件夹，导航到该文件夹中，并通过输入以下命令在该文件夹 (.) 中打开 VS Code (code)

mkdir projects
cd projects
mkdir helloworld
cd helloworld
code .

“code .” 命令在当前工作文件夹中打开 VS Code，该文件夹将成为你的“工作区”。在学习本教程的过程中，你将看到在工作区的 .vscode 文件夹中创建了三个文件

  • tasks.json（构建说明）
  • launch.json（调试器设置）
  • c_cpp_properties.json（编译器路径和 IntelliSense 设置）

添加源代码文件

在“文件资源管理器”标题栏中，选择“新建文件”按钮，并将文件命名为 helloworld.cpp。

New File title bar button

添加 hello world 源代码

现在粘贴此源代码

#include <iostream>
#include <vector>
#include <string>

using namespace std;

int main()
{
    vector<string> msg {"Hello", "C++", "World", "from", "VS Code", "and the C++ extension!"};

    for (const string& word : msg)
    {
        cout << word << " ";
    }
    cout << endl;
}

现在按 ⌘S (Windows, Linux Ctrl+S) 保存文件。请注意，你刚刚添加的文件是如何显示在 VS Code 侧边栏的“文件资源管理器”视图 (⇧⌘E (Windows, Linux Ctrl+Shift+E)) 中的

File Explorer

你还可以通过在主“文件”菜单中选中“自动保存”来启用自动保存，以自动保存你的文件更改。

最左侧的活动栏允许你打开不同的视图，例如“搜索”、“源代码管理”和“运行”。你将在本教程的后面部分查看“运行”视图。你可以在 VS Code 用户界面文档中找到有关其他视图的更多信息。

注意：当你保存或打开 C++ 文件时，你可能会看到来自 C/C++ 扩展的有关 Insiders 版本可用性的通知，该版本允许你测试新功能和修复。你可以通过选择 X（清除通知）来忽略此通知。

探索 IntelliSense

在你新的 helloworld.cpp 文件中，将鼠标悬停在 vector 或 string 上以查看类型信息。在声明 msg 变量后，开始键入 msg.，就像在调用成员函数时一样。你应该立即看到一个完成列表，其中显示所有成员函数，以及一个窗口，其中显示 msg 对象的类型信息

Statement completion IntelliSense

你可以按 Tab 键插入选定的成员；然后，当你添加左括号时，你将看到有关函数所需的任何参数的信息。

运行 helloworld.cpp

请记住，C++ 扩展使用你安装在计算机上的 C++ 编译器来构建你的程序。在尝试在 VS Code 中运行和调试 helloworld.cpp 之前，请确保你已安装 C++ 编译器。

  1. 打开 helloworld.cpp，使其成为活动文件。

  2. 按编辑器右上角的“播放”按钮。

    Screenshot of helloworld.cpp and play button

  3. 从系统上检测到的编译器列表中选择“C/C++: cl.exe 生成和调试活动文件”。

    C++ debug configuration dropdown

你只需在首次运行 helloworld.cpp 时选择编译器。此编译器将在 tasks.json 文件中设置为“默认”编译器。

  1. 构建成功后，程序的输出将显示在集成的“终端”中。

    screenshot of program output

如果你在尝试使用 cl.exe 构建和调试时遇到错误，请确保你已使用 code . 快捷方式从 Visual Studio 的 Developer Command Prompt 启动了 VS Code。

Error notification when trying to use MSVC without running VS Code from the Developer Command Prompt for VS

首次运行程序时，C++ 扩展会创建 tasks.json，你可以在项目的 .vscode 文件夹中找到它。tasks.json 存储构建配置。

你的新 tasks.json 文件应类似于下面的 JSON

{
  "version": "2.0.0",
  "tasks": [
    {
      "type": "shell",
      "label": "C/C++: cl.exe build active file",
      "command": "cl.exe",
      "args": [
        "/Zi",
        "/EHsc",
        "/Fe:",
        "${fileDirname}\\${fileBasenameNoExtension}.exe",
        "${file}"
      ],
      "problemMatcher": ["$msCompile"],
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "detail": "Task generated by Debugger."
    }
  ]
}

注意：你可以在变量参考中了解有关 tasks.json 变量的更多信息。

command 设置指定要运行的程序；在本例中为 “cl.exe”。args 数组指定将传递给 cl.exe 的命令行参数。这些参数必须按照编译器期望的顺序指定。

此任务告诉 C++ 编译器获取活动文件 (${file})，对其进行编译，并在当前目录 (${fileDirname}) 中创建一个可执行文件（/Fe: 开关），该文件与活动文件同名，但带有 .exe 扩展名 (${fileBasenameNoExtension}.exe)，对于我们的示例，结果为 helloworld.exe。

label 值是你将在任务列表中看到的内容；你可以随意命名它。

detail 值是你将在任务列表中看到的任务描述。强烈建议重命名此值，以将其与类似任务区分开来。

problemMatcher 值选择用于查找编译器输出中错误和警告的输出分析器。对于 cl.exe，如果使用 $msCompile 问题匹配器，你将获得最佳结果。

从现在开始，“播放”按钮将从 tasks.json 读取，以了解如何构建和运行你的程序。你可以在 tasks.json 中定义多个构建任务，并且标记为默认值的任务将由“播放”按钮使用。如果你需要更改默认编译器，可以运行“任务: 配置默认构建任务”。或者，你可以修改 tasks.json 文件并通过替换此段来删除默认值

    "group": {
        "kind": "build",
        "isDefault": true
    },

替换为这段

    "group": "build",

修改 tasks.json

你可以修改你的 tasks.json 以构建多个 C++ 文件，方法是使用类似 "${workspaceFolder}/*.cpp" 的参数而不是 "${file}"。这将构建当前文件夹中的所有 .cpp 文件。你还可以通过将 "${fileDirname}\\${fileBasenameNoExtension}.exe" 替换为硬编码的文件名（例如 "${workspaceFolder}\\myProgram.exe"）来修改输出文件名。

调试 helloworld.cpp

要调试你的代码，

  1. 返回到 helloworld.cpp，使其成为活动文件。
  2. 通过单击编辑器边距或在当前行上使用 F9 设置断点。helloworld.cpp 中断点的屏幕截图
  3. 从“播放”按钮旁边的下拉列表中，选择“调试 C/C++ 文件”。播放按钮下拉菜单的屏幕截图
  4. 从系统上检测到的编译器列表中选择“C/C++: cl.exe 生成和调试活动文件”（你只需在首次运行或调试 helloworld.cpp 时选择编译器）。C++ 调试配置下拉列表

“播放”按钮有两种模式：“运行 C/C++ 文件”和“调试 C/C++ 文件”。它将默认为上次使用的模式。如果你在“播放”按钮中看到调试图标，则可以选择“播放”按钮进行调试，而不是选择下拉菜单项。

如果你在尝试使用 cl.exe 构建和调试时遇到错误，请确保你已使用 code . 快捷方式从 Visual Studio 的 Developer Command Prompt 启动了 VS Code。

Error notification when trying to use MSVC without running VS Code from the Developer Command Prompt for VS

探索调试器

在你开始单步执行代码之前，让我们花一点时间注意用户界面中的几个变化

  • 集成终端出现在源代码编辑器的底部。在“调试输出”选项卡中，你将看到指示调试器正在运行的输出。

  • 编辑器突出显示你在启动调试器之前设置断点的行

    Initial breakpoint

  • 左侧的“运行和调试”视图显示调试信息。你将在本教程的后面部分看到一个示例。

  • 在代码编辑器的顶部，会出现一个调试控制面板。你可以通过抓住左侧的点在屏幕上移动它。

    Debugging controls

单步执行代码

现在你已准备好开始单步执行代码。

  1. 单击或按调试控制面板中的“步过”图标。

    Step over button

    这将使程序执行前进到 for 循环的第一行，并跳过在创建和初始化 msg 变量时调用的 vector 和 string 类中的所有内部函数调用。注意左侧“变量”窗口中的变化。

    Debugging windows

    在本例中，错误是预期的，因为尽管循环的变量名称现在对调试器可见，但语句尚未执行，因此此时没有任何内容可读取。但是，msg 的内容是可见的，因为该语句已完成。

  2. 再次按“步过”以前进到此程序中的下一个语句（跳过所有为初始化循环而执行的内部代码）。现在，“变量”窗口显示有关循环变量的信息。

  3. 再次按“步过”以执行 cout 语句。（请注意，C++ 扩展在循环退出之前不会将任何输出打印到“调试控制台”。）

  4. 如果你愿意，可以继续按“步过”，直到向量中的所有单词都已打印到控制台。但如果你好奇，请尝试按“步入”按钮以单步执行 C++ 标准库中的源代码！

    Breakpoint in gcc standard library header

    要返回到你自己的代码，一种方法是继续按“步过”。另一种方法是在你的代码中设置断点，方法是切换到代码编辑器中的 helloworld.cpp 选项卡，将插入点放在循环内的 cout 语句的某个位置，然后按 F9。左侧的装订线中会出现一个红点，指示已在此行上设置断点。

    Breakpoint in main

    然后按 F5 以从标准库标头中的当前行开始执行。执行将在 cout 处中断。如果你愿意，可以再次按 F9 以关闭断点。

设置监视

有时你可能想在程序执行时跟踪变量的值。你可以通过在变量上设置监视来执行此操作。

  1. 将插入点放在循环内。在“监视”窗口中，选择加号，然后在文本框中键入 word，这是循环变量的名称。现在在单步执行循环时查看“监视”窗口。

    Watch window

  2. 通过在循环之前添加此语句来添加另一个监视：int i = 0;。然后，在循环内，添加此语句：++i;。现在像上一步一样为 i 添加监视。

  3. 要在执行在断点处暂停时快速查看任何变量的值，你可以将鼠标指针悬停在其上方。

    Mouse hover

使用 launch.json 自定义调试

当你使用“播放”按钮或 F5 进行调试时，C++ 扩展会动态创建调试配置。

在某些情况下，你可能需要自定义调试配置，例如指定在运行时传递给程序的参数。你可以在 launch.json 文件中定义自定义调试配置。

要创建 launch.json，请从“播放”按钮下拉菜单中选择“添加调试配置”。

Add debug configuration play button menu

然后你将看到各种预定义调试配置的下拉列表。选择“C/C++: cl.exe 生成和调试活动文件”。

C++ debug configuration dropdown

VS Code 创建一个 launch.json 文件，它看起来像这样

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "C/C++: cl.exe build and debug active file",
      "type": "cppvsdbg",
      "request": "launch",
      "program": "${fileDirname}\\${fileBasenameNoExtension}.exe",
      "args": [],
      "stopAtEntry": false,
      "cwd": "${workspaceFolder}",
      "environment": [],
      "externalConsole": false,
      "preLaunchTask": "C/C++: cl.exe build active file"
    }
  ]
}

在上面的 JSON 中，program 指定你要调试的程序。此处将其设置为活动文件文件夹 (${fileDirname}) 和带有 .exe 扩展名的活动文件名 (${fileBasenameNoExtension}.exe)，如果 helloworld.cpp 是活动文件，则为 helloworld.exe。args 属性是要在运行时传递给程序的参数数组。

默认情况下，C++ 扩展不会向你的源代码添加任何断点，并且 stopAtEntry 值设置为 false。

将 stopAtEntry 值更改为 true，以使调试器在开始调试时在 main 方法处停止。

从现在开始，“播放”按钮和 F5 将在启动程序进行调试时从你的 launch.json 文件读取。

C/C++ 配置

如果你想更好地控制 C/C++ 扩展，可以创建一个 c_cpp_properties.json 文件，该文件允许你更改设置，例如编译器的路径、包含路径、C++ 标准（默认为 C++17）等等。

你可以通过从命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 运行命令“C/C++: 编辑配置(UI)”来查看 C/C++ 配置 UI。

Command Palette

这将打开“C/C++ 配置”页面。当你在此处进行更改时，VS Code 会将它们写入 .vscode 文件夹中名为 c_cpp_properties.json 的文件。

Command Palette

Visual Studio Code 将这些设置放在 .vscode\\c_cpp_properties.json 中。如果你直接打开该文件，它应该看起来像这样

{
  "configurations": [
    {
      "name": "Win32",
      "includePath": ["${workspaceFolder}/**"],
      "defines": ["_DEBUG", "UNICODE", "_UNICODE"],
      "windowsSdkVersion": "10.0.18362.0",
      "compilerPath": "C:/Program Files (x86)/Microsoft Visual Studio/2019/BuildTools/VC/Tools/MSVC/14.24.28314/bin/Hostx64/x64/cl.exe",
      "cStandard": "c11",
      "cppStandard": "c++17",
      "intelliSenseMode": "msvc-x64"
    }
  ],
  "version": 4
}

如果你的程序包含不在你的工作区或标准库路径中的头文件，你才需要添加到“包含路径”数组设置。

编译器路径

compilerPath 设置是配置中的一个重要设置。扩展使用它来推断 C++ 标准库头文件的路径。当扩展知道在何处找到这些文件时，它可以提供有用的功能，例如智能补全和“转到定义”导航。

C/C++ 扩展尝试根据在你的系统上找到的内容使用默认编译器位置填充 compilerPath。扩展在几个常见的编译器位置中查找。

compilerPath 搜索顺序为

  • 首先检查 Microsoft Visual C++ 编译器
  • 然后在 Windows Linux 子系统 (WSL) 上查找 g++
  • 然后查找 Mingw-w64 的 g++。

如果你安装了 g++ 或 WSL，你可能需要更改 compilerPath 以匹配你的项目的首选编译器。对于 Microsoft C++，路径应类似于这样，具体取决于你安装的特定版本：“C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/VC/Tools/MSVC/14.16.27023/bin/Hostx64/x64/cl.exe”。

重用 C++ 配置

VS Code 现在已配置为使用 Microsoft C++ 编译器。该配置适用于当前工作区。要重用配置，只需将 JSON 文件复制到新项目文件夹（工作区）中的 .vscode 文件夹，并根据需要更改源文件和可执行文件的名称。

在 Developer Command Prompt 之外运行 VS Code

在某些情况下，无法从 Visual Studio 的 Developer Command Prompt 运行 VS Code（例如，在通过 SSH 进行远程开发的场景中）。在这种情况下，你可以使用以下 tasks.json 配置在构建期间自动初始化 Visual Studio 的 Developer Command Prompt

{
  "version": "2.0.0",
  "windows": {
    "options": {
      "shell": {
        "executable": "cmd.exe",
        "args": [
          "/C",
          // The path to VsDevCmd.bat depends on the version of Visual Studio you have installed.
          "\"C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/Common7/Tools/VsDevCmd.bat\"",
          "&&"
        ]
      }
    }
  },
  "tasks": [
    {
      "type": "shell",
      "label": "cl.exe build active file",
      "command": "cl.exe",
      "args": [
        "/Zi",
        "/EHsc",
        "/Fe:",
        "${fileDirname}\\${fileBasenameNoExtension}.exe",
        "${file}"
      ],
      "problemMatcher": ["$msCompile"],
      "group": {
        "kind": "build",
        "isDefault": true
      }
    }
  ]
}

注意：VsDevCmd.bat 的路径可能因 Visual Studio 版本或安装路径而异。你可以通过打开命令提示符并运行 dir "\VsDevCmd*" /s 来查找 VsDevCmd.bat 的路径。

故障排除

术语 'cl.exe' 无法识别

如果你看到错误“术语 'cl.exe' 无法识别为 cmdlet、函数、脚本文件或可操作程序的名称。”，这通常意味着你在 Visual Studio 的 Developer Command Prompt 之外运行 VS Code，并且 VS Code 不知道 cl.exe 编译器的路径。

VS Code 必须从 Visual Studio 的 Developer Command Prompt 启动，或者必须将任务配置为在 Developer Command Prompt 之外运行。

你始终可以通过打开一个新的“终端”(⌃⇧` (Windows, Linux Ctrl+Shift+`)) 并键入 'cl' 来验证 cl.exe 是否可用于 VS Code，从而检查你是否在 Developer Command Prompt 的上下文中运行 VS Code。

致命错误 C1034: assert.h: 未设置包含路径

在这种情况下，cl.exe 可通过 PATH 环境变量用于 VS Code，但 VS Code 仍然需要从 Visual Studio 的 Developer Command Prompt 启动，或者配置为在 Developer Command Prompt 之外运行。否则，cl.exe 无法访问重要的环境变量，例如 INCLUDE。

后续步骤

  • 探索 VS Code 用户指南。
  • 查看 C++ 扩展概述。
  • 创建一个新的工作区，将你的 .vscode JSON 文件复制到其中，调整新工作区路径、程序名称等必要的设置，然后开始编码！
3/7/2023