配置 VS Code 用于 Microsoft C++

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++ 扩展。您可以通过在扩展视图中搜索 'c++' 来安装 C/C++ 扩展 (⇧⌘X (Windows, Linux Ctrl+Shift+X))。
安装 Microsoft Visual C++ (MSVC) 编译器工具集。

如果你有最新版本的Visual Studio，请从Windows开始菜单中打开Visual Studio-installer，并确保C++工作负载已选中。如果没有安装，请勾选该框并选择修改按钮进行安装。

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

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

注意：您可以使用来自Visual Studio Build Tools的C++工具集以及Visual Studio Code来开发、构建和测试任何C++代码，只要您也有有效的Visual Studio许可证（无论是Community、Pro还是Enterprise）。

检查您的 Microsoft Visual C++ 安装情况

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

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

你可以测试你是否拥有C++编译器，cl.exe正确安装后，输入 'cl'，你应该会看到带有版本和基本使用说明的版权信息。

检查 cl.exe 安装

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

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

创建 Hello World

在开发者命令提示符下，创建一个名为“projects”的空文件夹，用于存储所有你的 VS Code 项目，然后创建一个名为“helloworld”的子文件夹，导航到该文件夹，并打开 VS Code。代码) 在那个文件夹中 (输入：.) 通过输入以下命令：

创建目录 项目
进入目录 项目
创建目录 你好世界
进入目录 你好世界
在当前目录下打开代码编辑器

"code ." 命令在当前工作文件夹中打开 VS Code，这将成为你的 "工作区"。在完成教程时，你会看到三个文件被创建。.vscode工作区中的文件夹：

任务.json（构建说明）
launch.json(调试器设置)
c_cpp_properties.json（编译器路径和IntelliSense设置）

添加源代码文件

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

添加 hello world 源代码

现在将此源代码粘贴：

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

使用 命名空间 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）来保存文件。注意你刚刚添加的文件出现在文件资源管理器视图（⇧⌘E（Windows, Linux Ctrl+Shift+E））VS Code的侧栏中：

文件资源管理器

您还可以启用自动保存，通过在主文件菜单中勾选自动保存。

最左边的活动栏允许您打开不同的视图，例如搜索、源代码控制和运行。您将在本教程的后面部分查看运行视图。您可以在 VS Code 用户界面文档中了解更多关于其他视图的信息。

注意：当您保存或打开一个 C++ 文件时，您可能会看到来自 C/C++ 扩展的通知，告知您内测版本的可用性，这使您可以测试新功能和修复。您可以选择来忽略此通知。输入：X (清除通知).

探索IntelliSense

在你的新helloworld.cpp文件，悬停在向量或字符串要查看类型信息。在声明之后消息变量，开始输入消息。就像调用成员函数时一样。你应该立即看到一个完成列表，显示所有成员函数，并显示类型信息的Windows。消息对象:

语句完成IntelliSense

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

运行 helloworld.cpp

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

打开helloworld.cpp这样它就是活动文件。
按编辑器右上角的播放按钮。
选择 C/C++: cl.exe 编译和调试当前文件 从系统中检测到的编译器列表中。

您只有在第一次运行时才会被要求选择一个编译器helloworld.cpp. 这个编译器将被设置为“默认”编译器任务.json文件。

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

如果你在使用 cl.exe 进行构建和调试时遇到错误，请确保你从 Visual Studio 的开发人员命令提示符启动 VS Code使用 代码快捷方式。

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

第一次运行你的程序时，C++ 扩展会创建任务.json，你将在项目中找到.vscode文件夹。任务.json商店构建配置。

您的新任务.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"："任务由调试器生成。"
    }
  ]
}

注意：您可以了解更多关于任务.json 变量在变量参考中。

该命令设置指定了要运行的程序；在这种情况下是 "cl.exe"。参数数组指定了将传递给cl.exe的命令行参数。这些参数必须按照编译器期望的顺序指定。

此任务告诉C++编译器使用当前活动文件（${文件})，编译它，并创建一个可执行文件/铁:在当前目录中切换${文件目录}) 与活动文件同名但扩展名不同.exe扩展 (${文件名无扩展名}.exe)，导致helloworld.exe例如我们的例子。

该Tabvalue 是你在任务列表中会看到的内容；你可以随意命名。

该细节value是你在任务列表中执行任务的描述。强烈建议将此值重命名为与其他相似任务区分开来。

该问题匹配器value 选择用于在编译器输出中查找错误和警告的输出解析器。对于 cl.exe，如果您使用$ms编译问题匹配器。

从现在开始，播放按钮将从任务.json要弄清楚如何构建和运行你的程序。你可以在中定义多个构建任务任务.json，并且无论哪个任务被标记为默认任务，将会被播放按钮使用。如果你需要更改默认编译器，可以运行任务：配置默认构建任务。或者，你可以修改任务.json文件并移除默认值，通过替换这一段：

    "组": {
        "类型": "构建",
        "是否默认": true
    },

用这个：

    "组"："构建"，

修改 tasks.json

您可以修改您的任务.json通过使用像这样的参数来编译多个 C++ 文件"${workspaceFolder}/*.cpp"而不是"${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 进行构建和调试时遇到错误，请确保你从 Visual Studio 的开发人员命令提示符启动 VS Code使用 代码快捷方式。

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

探索调试器

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

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

逐步执行代码

现在你准备开始逐行执行代码了。

点击或按单步跳过图标在调试控制面板中。

这将使程序执行跳转到for循环的第一行，并跳过其中的所有内部函数调用向量和字符串调用的类消息 变量已创建并初始化。请注意左侧面板上的变量Windows中的变化。

在这种情况下，出现错误是预期的，因为虽然循环的变量名称现在对调试器可见，但语句尚未执行，因此此时没有可读的内容。消息然而，这些是可见的，因为该语句已完成。
按 单步执行 再次以跳过所有执行的内部代码，转到此程序的下一条语句。现在，变量 Windows显示有关循环变量的信息。
按 单步执行 再次执行 输出流对象 语句。(请注意，C++ 扩展在循环结束之前不会在调试控制台中打印任何输出。)
如果你愿意，你可以继续按单步执行，直到向量中的所有单词都打印到控制台。但如果你很好奇，可以按单步进入按钮，逐步执行C++标准库的源代码！

要返回自己的代码，一种方法是继续按单步执行。另一种方法是在代码中设置断点，切换到helloworld.cpp在代码编辑器中按Tab键，将插入点放置在某处输出流对象 循环中的语句，并按 F9。在左侧的边缘上会出现一个红色的点，表示已在此行上设置断点。

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

设置闹钟

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

将插入点放置在循环内。在监视Windows中，选择加号并在文本框中输入单词，这是循环变量的名称。现在在逐步执行循环时查看WatchWindows。
在循环之前添加此语句以添加另一个手表：整型变量 i 赋值为 0;然后，在循环体内添加此语句：++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中，程序指定您要调试的程序。这里设置为活动文件夹 (${文件目录}) 和活动的文件名与.exe扩展 (${文件名无扩展名}.exe), 如果helloworld.cpp将是活动文件helloworld.exe。参数属性是传递给程序的运行时参数数组。

默认情况下，C++ 扩展不会向你的源代码添加任何断点，并且在入口处停止值被设置为假输入：.

更改在入口处停止值到真使调试器在...处停止主要开始调试时的方法。

从现在开始，播放按钮和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 会将它们写入名为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
}

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

编译路径

该编译器路径 C++ 标准库头文件的路径是您配置中的一个重要设置。扩展使用它来推断 C++ 标准库头文件的路径。当扩展知道如何找到这些文件时，它可以提供有用的特性，例如智能完成和转到定义导航。

C/C++ 扩展尝试填充编译器路径使用默认的编译器位置，基于在您的系统上找到的内容。该扩展在几个常见的编译器位置查找。

该编译器路径搜索顺序是：

首先检查微软 Visual C++ 编译器
然后在Windows Subsystem for Linux (WSL)中寻找g++
然后是 Mingw-w64 的 g++。

如果你安装了g++或WSL，你可能需要更改编译器路径以匹配您项目首选的编译器。对于 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）的初始化。任务.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 Studio 的开发者命令提示符 外运行 VS Code，VS Code 不知道 cl.exe编译器。

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

您始终可以通过打开新的终端 (⌃⇧` (Windows, Linux Ctrl+Shift+`)) 并输入 'cl' 来验证您是否在开发者命令提示符的上下文中运行 VS Codecl.exe可提供给 VS Code。

致命错误 C1034: 声称.h: 没有设置包含路径

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

下一步

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