为 Microsoft C++ 配置 VS Code

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

配置完 VS Code 后，您将在 VS Code 中编译和调试一个简单的 Hello World 程序。本教程不会向您介绍有关 Microsoft C++ 工具集或 C++ 语言的详细信息。对于这些主题，网络上有许多好的资源。

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

先决条件

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

  1. 安装Visual Studio 代码。

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

    C/C++ 扩展

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

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

    您还可以安装带有 C++工作负载的桌面开发，而无需安装完整的 Visual Studio IDE。在 Visual Studio下载页面中，向下滚动，直到在“所有下载”部分下看到Tools for Visual Studio ，然后选择Build Tools for Visual Studio 2022的下载。

    Visual Studio 构建工具下载

    这将启动 Visual Studio 安装程序，并弹出一个对话框，显示可用的 Visual Studio 构建工具工作负载。检查“使用 C++ 进行桌面开发”工作负载并选择“安装”。

    Cpp 构建工具工作负载

注意：只要您还拥有有效的 Visual Studio 许可证（社区版、专业版或企业版），您就可以使用 Visual Studio 构建工具中的 C++ 工具集以及 Visual Studio Code 来编译、构建和验证任何 C++ 代码库。正在积极使用该 C++ 代码库来开发。

检查您的 Microsoft Visual C++ 安装

要从命令行或 VS Code 使用 MSVC，必须从Visual Studio 的开发人员命令提示符运行。普通 shell（例如 PowerShell、Bash 或 Windows 命令提示符）没有设置必要的路径环境变量。

要打开 VS 的开发人员命令提示符，请开始在 Windows“开始”菜单中键入“开发人员”，您应该会看到它出现在建议列表中。确切的名称取决于您安装的 Visual Studio 或 Visual Studio 构建工具的版本。选择该项目以打开提示。

开发者命令提示符

cl.exe您可以通过键入“cl”来测试您是否已正确安装 C++ 编译器，并且您应该会看到一条包含版本和基本使用说明的版权消息。

检查 cl.exe 安装

如果开发人员命令提示符使用 BuildTools 位置作为起始目录（您不想将项目放在那里），请在开始创建新项目之前导航到您的用户文件夹 ( C:\users\{your username}\)。

注意：如果由于某种原因您无法从开发人员命令提示符运行 VS Code，您可以在“在开发人员命令提示符之外运行 VS Code”中找到使用 VS Code 构建 C++ 项目的解决方法。

创建你好世界

从开发人员命令提示符中，创建一个名为“projects”的空文件夹，您可以在其中存储所有 VS Code 项目，然后创建一个名为“helloworld”的子文件夹，导航到该文件夹​​，然后通过输入在该文件夹 ( ) 中打开 VS Code ( code).以下命令：

mkdir projects
cd projects
mkdir helloworld
cd helloworld
code .

代码 。” 命令在当前工作文件夹中打开 VS Code，该文件夹将成为您的“工作区”。当您完成本教程时，您将看到在.vscode工作区的文件夹中创建的三个文件：

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

添加源代码文件

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

新建文件标题栏按钮

添加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 ) ）中：

文件管理器

您还可以通过选中主文件菜单中的自动保存来启用自动保存以自动保存文件更改。

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

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

探索智能感知

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

语句完成智能感知

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

运行helloworld.cpp

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

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

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

    helloworld.cpp 和播放按钮的屏幕截图

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

    C++ 调试配置下拉列表

仅在第一次运行时才会要求您选择编译器helloworld.cpp。该编译器将被设置为tasks.json文件中的“默认”编译器。

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

    程序输出截图

如果尝试使用 cl.exe 生成和调试时出现错误，请确保已使用快捷方式从 Visual Studio 的开发人员命令提示符启动 VS Codecode .。

尝试使用 MSVC 而不从 VS 开发人员命令提示符运行 VS Code 时出现错误通知

第一次运行程序时，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}创建一个与活动文件同名但扩展名( ) 的可执行文件 ( switch)，结果是例子。/Fe:${fileDirname}.exe${fileBasenameNoExtension}.exehelloworld.exe

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

该detail值是您将作为任务列表中的任务描述的值。强烈建议重命名该值以将其与类似任务区分开来。

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

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

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

有了这个：

    "group": "build",

修改tasks.json

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

调试helloworld.cpp

要调试您的代码，

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

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

如果尝试使用 cl.exe 生成和调试时出现错误，请确保已使用快捷方式从 Visual Studio 的开发人员命令提示符启动 VS Codecode .。

尝试使用 MSVC 而不从 VS 开发人员命令提示符运行 VS Code 时出现错误通知

探索调试器

在开始逐步执​​行代码之前，让我们花点时间注意一下用户界面中的一些变化：

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

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

    初始断点

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

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

    调试控件

单步执行代码

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

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

    跨过按钮

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

    调试窗口

    在这种情况下，错误是预料之中的，因为虽然循环的变量名现在对调试器可见，但该语句尚未执行，因此此时没有任何内容可读取。然而，的内容msg是可见的，因为该语句已经完成。

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

  3. 再次按Step over执行该cout语句。（请注意，截至 2019 年 3 月版本，C++ 扩展在循环退出之前不会将任何输出打印到调试控制台。）

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

    gcc 标准库头中的断点

    要返回到您自己的代码，一种方法是按住Step over。另一种方法是在代码中设置断点，方法是切换到helloworld.cpp代码编辑器中的选项卡，将插入点放在cout循环内语句的某处，然后按F9。左侧装订线中出现一个红点，表示已在此行设置断点。

    main 中的断点

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

设置手表

有时您可能希望在程序执行时跟踪变量的值。您可以通过对变量设置监视来做到这一点。

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

    观察窗

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

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

    鼠标悬停

使用 launch.json 自定义调试

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

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

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

添加调试配置播放按钮菜单

然后，您将看到各种预定义调试配置的下拉列表。选择C/C++：cl.exe构建和调试活动文件。

C++ 调试配置下拉列表

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）等设置。

您可以通过运行命令 C/C++ ：从命令面板编辑配置 (UI) ( ⇧⌘P (Windows、Linux Ctrl+Shift+P ) ) 查看 C/C++ 配置 UI。

命令面板

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

命令面板

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++ 编译器Ope
  • 然后在 Windows Subsystem for 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新项目文件夹（工作区）中的文件夹，并根据需要更改源文件和可执行文件的名称。

在开发人员命令提示符之外运行 VS Code

在某些情况下，无法从Visual Studio 的开发人员命令提示符运行 VS Code （例如，在通过 SSH 进行远程开发的情况下）。在这种情况下，您可以使用以下配置在构建过程中自动初始化Visual Studio 的开发人员命令提示符tasks.json：

{
  "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 版本或安装路径，路径可能会有所不同。VsDevCmd.bat您可以通过打开命令提示符并运行来找到路径dir "\VsDevCmd*" /s。

故障排除

无法识别术语“cl.exe”

如果您看到错误“术语‘cl.exe’未被识别为 cmdlet、函数、脚本文件或可操作程序的名称。”，这通常意味着您正在Visual 开发人员命令提示符之外运行 VS Code Studio和 VS Code 不知道编译器的路径cl.exe。

VS Code 必须从 Visual Studio 的开发人员命令提示符启动，或者必须将任务配置为在开发人员命令提示符之外运行。

您始终可以通过打开新终端 ( ⌃⇧` (Windows、Linux Ctrl+Shift+` ) ) 并输入“cl”来验证VS Codecl.exe是否可用，以检查您是否正在开发人员命令提示符上下文中运行 VS Code 。

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

在这种情况下，cl.exe可通过环境变量供 VS Code 使用PATH，但 VS Code 仍需要从Visual Studio 的开发人员命令提示符启动，或者配置为在开发人员命令提示符之外运行。否则，cl.exe无法访问重要的环境变量，例如INCLUDE.

下一步

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