Edit

为Microsoft C++配置VS Code

Name: Visual Studio Code
Author: Microsoft

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

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

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

先决条件

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

安装 Visual Studio Code。
安装VS Code的C/C++扩展。您可以通过在扩展视图（⇧⌘X (Windows, Linux Ctrl+Shift+X)）中搜索'c++'来安装C/C++扩展。
安装 Microsoft Visual C++ (MSVC) 编译器工具集。

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

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

这将启动Visual Studio安装程序，它将显示一个对话框，展示可用的Visual Studio Build Tools工作负载。勾选使用C++进行桌面开发工作负载，然后选择安装。

注意: 只要您还拥有一个有效的Visual Studio许可证（无论是Community、Pro还是Enterprise），并且正在积极使用该许可证来开发C++代码库，您就可以使用Visual Studio Build Tools中的C++工具集与Visual Studio Code一起编译、构建和验证任何C++代码库。

检查您的 Microsoft Visual C++ 安装

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

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

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

检查cl.exe安装

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

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

创建 Hello World

从开发者命令提示符中，创建一个名为“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。

添加 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（清除通知）来忽略此通知。

探索 IntelliSense

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

语句完成智能感知

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

运行 helloworld.cpp

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

打开 helloworld.cpp 使其成为活动文件。
按下编辑器右上角的播放按钮。
从系统检测到的编译器列表中选择C/C++: cl.exe 构建并调试活动文件。

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

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

如果您在尝试使用 cl.exe 构建和调试时遇到错误，请确保您已从 Visual Studio 的开发者命令提示符使用 code . 快捷方式启动了 VS Code。

尝试使用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}），编译它，并在当前目录（${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，通过使用像"${workspaceFolder}/*.cpp"这样的参数来构建多个C++文件，而不是"${file}"。这将构建你当前文件夹中的所有.cpp文件。你也可以通过将"${fileDirname}\\${fileBasenameNoExtension}.exe"替换为硬编码的文件名（例如"${workspaceFolder}\\myProgram.exe"）来修改输出文件名。

调试 helloworld.cpp

调试你的代码，

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

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

如果您在尝试使用cl.exe构建和调试时遇到错误，请确保您已使用code .快捷方式从Visual Studio的开发者命令提示符启动了VS Code。

尝试在不从VS的开发者命令提示符运行VS Code的情况下使用MSVC时的错误通知

探索调试器

在开始逐步查看代码之前，让我们花点时间注意用户界面中的几个变化：

集成终端出现在源代码编辑器的底部。在调试输出标签中，您可以看到指示调试器已启动并正在运行的输出。
编辑器在启动调试器之前突出显示您设置断点的行：
左侧的运行和调试视图显示调试信息。在本教程的后面部分，您将看到一个示例。
在代码编辑器的顶部，会出现一个调试控制面板。你可以通过抓住左侧的点来在屏幕上移动它。

逐步执行代码

现在你已经准备好开始逐步执行代码了。

点击或按下调试控制面板中的跳过图标。

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

在这种情况下，错误是预期的，因为尽管循环的变量名称现在对调试器可见，但语句尚未执行，因此此时没有内容可读取。然而，msg的内容是可见的，因为该语句已经完成。
再次按下Step over以推进到程序中的下一个语句（跳过所有用于初始化循环的内部代码）。现在，Variables窗口显示了有关循环变量的信息。
再次按下Step over以执行cout语句。（请注意，C++扩展在循环退出之前不会向Debug Console打印任何输出。）
如果你愿意，你可以一直按Step over，直到向量中的所有单词都被打印到控制台。但如果你好奇，试试按Step Into按钮，逐步查看C++标准库中的源代码！

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

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

设置监视

有时你可能希望在程序执行时跟踪变量的值。你可以通过在变量上设置监视来实现这一点。

将插入点放在循环内部。在监视窗口中，选择加号并在文本框中输入word，这是循环变量的名称。现在，当您逐步执行循环时，查看监视窗口。
在循环之前添加另一个监视，通过添加这个语句：int i = 0;。然后，在循环内部，添加这个语句：++i;。现在像上一步一样为i添加一个监视。
要在执行在断点处暂停时快速查看任何变量的值，您可以将鼠标指针悬停在其上。

使用 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)来查看C/C++配置界面（⇧⌘P (Windows, Linux Ctrl+Shift+P)）。

命令面板

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

命令面板

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
然后在适用于 Linux 的 Windows 子系统 (WSL) 上查找 g++
然后使用 g++ 编译 Mingw-w64。

如果您已安装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 进行远程开发的情况下）。在这种情况下，您可以使用以下tasks.json配置在构建期间自动初始化Visual Studio 的开发者命令提示符：

{
  "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' 未被识别

如果你看到错误信息“The term 'cl.exe' is not recognized as the name of a cmdlet, function, script file, or operable program.”，这通常意味着你在Visual Studio 的开发者命令提示符之外运行 VS Code，并且 VS Code 不知道 cl.exe 编译器的路径。

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

您可以通过打开一个新的终端（⌃⇧` (Windows, Linux Ctrl+Shift+`)）并输入'cl'来验证cl.exe是否对VS Code可用，从而始终检查您是否在开发者命令提示符的上下文中运行VS Code。

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

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

下一步

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

3/7/2023