🚀 在 VS Code 中免费获取 ！

在 VS Code 中使用 C++ 和 WSL

在本教程中，您将配置 Visual Studio Code 以在 适用于 Linux 的 Windows 子系统 (WSL) 中的 Ubuntu 上使用 GCC C++ 编译器 (g++) 和 GDB 调试器。GCC 代表 GNU 编译器集合；GDB 是 GNU 调试器。WSL 是 Windows 中的 Linux 环境，它直接在机器硬件上运行，而不是在虚拟机中运行。

注意：本教程的大部分内容适用于直接在 Linux 机器上使用 C++ 和 VS Code。

Visual Studio Code 支持直接在 WSL 中使用 WSL 扩展。我们推荐这种 WSL 开发 模式，其中所有源代码文件以及编译器都托管在 Linux 发行版上。有关更多背景信息，请参阅 VS Code 远程开发。

完成本教程后，您将准备好创建和配置自己的 C++ 项目，并探索 VS Code 文档以获取有关其许多功能的更多信息。本教程不教您关于 GCC 或 Linux 或 C++ 语言的知识。对于这些主题，Web 上有许多优秀的资源。

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

先决条件

要成功完成本教程，您必须执行以下步骤

  1. 安装 Visual Studio Code。

  2. 安装 WSL 扩展。

  3. 安装 适用于 Linux 的 Windows 子系统，然后使用同一页面上的链接安装您选择的 Linux 发行版。本教程使用 Ubuntu。在安装过程中，请记住您的 Linux 用户密码，因为您需要它来安装其他软件。

设置 Linux 环境

  1. 打开 WSL 的 Bash shell。如果您安装了 Ubuntu 发行版，请在 Windows 搜索框中键入“Ubuntu”，然后在结果列表中单击它。对于 Debian，键入“Debian”，依此类推。

    Ubuntu in Start Menu

    shell 将出现一个命令提示符，默认情况下由您的用户名和计算机名组成，并将您置于您的主目录中。对于 Ubuntu，它看起来像这样

    Bash Shell

  2. 创建一个名为 projects 的目录，然后在该目录下创建一个名为 helloworld 的子目录

    mkdir projects
cd projects
mkdir helloworld

  3. 虽然您将使用 VS Code 来编辑您的源代码，但您将在 Linux 上使用 g++ 编译器编译源代码。您还将在 Linux 上使用 GDB 进行调试。这些工具默认情况下未安装在 Ubuntu 上，因此您必须安装它们。幸运的是，这项任务非常容易！

  4. 从 WSL 命令提示符下，首先运行 apt-get update 以更新 Ubuntu 包列表。过时的发行版有时会干扰安装新包的尝试。

    sudo apt-get update

    如果您愿意，您也可以运行 sudo apt-get update && sudo apt-get dist-upgrade 以下载最新版本的系统包，但这可能需要更长的时间，具体取决于您的连接速度。

  5. 从命令提示符下，通过键入以下命令安装 GNU 编译器工具和 GDB 调试器

    sudo apt-get install build-essential gdb

  6. 通过查找 g++ 和 gdb 来验证安装是否成功。如果文件名未从 whereis 命令返回，请尝试再次运行 update 命令。

    whereis g++
whereis gdb

注意：如果您直接在 Linux 机器上工作而不是在 WSL 中工作，则安装 g++ 编译器和 GDB 调试器的设置步骤适用。在您的 helloworld 项目中运行 VS Code，以及编辑、构建和调试步骤都是相同的。

在 WSL 中运行 VS Code

导航到您的 helloworld 项目文件夹，并使用 code . 从 WSL 终端启动 VS Code

cd $HOME/projects/helloworld
code .

您将看到一条关于“正在安装 VS Code Server”的消息。VS Code 正在 Linux 端下载并安装一个小服务器，桌面 VS Code 将与之通信。然后 VS Code 将启动并打开 helloWorld 文件夹。文件资源管理器显示 VS Code 现在在 WSL 的上下文中运行，标题栏为 WSL: Ubuntu。

File Explorer in WSL

您也可以从状态栏判断远程上下文。

Remote context in the Status bar

如果您单击远程状态栏项目，您将看到适用于会话的远程命令下拉列表。例如，如果您想结束在 WSL 中运行的会话，您可以从下拉列表中选择 关闭远程连接 命令。从您的 WSL 命令提示符运行 code . 将重新启动在 WSL 中运行的 VS Code。

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

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

添加源代码文件

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

New File title bar button

安装 C/C++ 扩展

一旦您创建文件并且 VS Code 检测到它是 C++ 语言文件，如果您尚未安装 Microsoft C/C++ 扩展，系统可能会提示您安装它。

C++ extension notification

当扩展视图中显示 重新加载必需 按钮时，选择 安装，然后选择 重新加载必需 以完成安装 C/C++ 扩展。

如果您已经在 VS Code 本地安装了 C/C++ 语言扩展，则需要转到扩展视图（⇧⌘X（Windows、Linux Ctrl+Shift+X）），并将这些扩展安装到 WSL 中。可以通过选择 在 WSL 中安装 按钮，然后选择 重新加载必需，将本地安装的扩展安装到 WSL 中。

Install in WSL 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 用户界面文档 中找到有关其他视图的更多信息。

探索 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. 从系统上检测到的编译器列表中选择 g++ 生成和调试活动文件。

    C++ debug configuration dropdown

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

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

    screenshot of program output

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

您的新 tasks.json 文件应与下面的 JSON 类似

{
  "version": "2.0.0",
  "tasks": [
    {
      "type": "shell",
      "label": "C/C++: g++ build active file",
      "command": "/usr/bin/g++",
      "args": ["-g", "${file}", "-o", "${fileDirname}/${fileBasenameNoExtension}"],
      "options": {
        "cwd": "/usr/bin"
      },
      "problemMatcher": ["$gcc"],
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "detail": "Task generated by Debugger."
    }
  ]
}

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

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

此任务告诉 g++ 获取活动文件 (${file})，编译它，并在当前目录 (${fileDirname}) 中创建一个可执行文件，该文件与活动文件同名，但不带扩展名 (${fileBasenameNoExtension})，对于我们的示例，结果为 helloworld。

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

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

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

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

为此

    "group": "build",

修改 tasks.json

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

调试 helloworld.cpp

要调试您的代码，

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

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

探索调试器

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

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

  • 编辑器突出显示第 12 行，这是您在启动调试器之前设置的断点

    Initial breakpoint

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

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

    Debugging controls

如果您的工作区中已经有一个 launch.json 文件，则播放按钮在确定如何运行和调试 C++ 文件时将从中读取。如果您没有 launch.json，则播放按钮将动态创建一个临时的“快速调试”配置，从而完全不需要 launch.json！

单步执行代码

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

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

    Step over button

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

    Debugging windows

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

  3. 再次按 单步跳过 以执行 cout 语句。（请注意，C++ 扩展在最后一个 cout 执行之前不会将任何输出打印到 调试控制台。）

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

    Breakpoint in gcc standard library header

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

    Breakpoint in main

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

    循环完成后，您可以在集成终端的 调试控制台 选项卡中看到输出，以及 GDB 输出的一些其他诊断信息。

    Debug console display

设置监视

要跟踪程序执行时变量的值，请在变量上设置 监视。

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

    Watch window

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

    Mouse hover

接下来，您将创建一个 tasks.json 文件，以告知 VS Code 如何构建（编译）程序。此任务将调用 g++ 编译器以从源代码创建可执行文件。

重要的是在编辑器中打开 helloworld.cpp，因为下一步使用编辑器中的活动文件作为上下文，以在下一步中创建构建任务。

使用 launch.json 自定义调试

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

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

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

Add debug configuration play button menu

然后，您将看到各种预定义的调试配置的下拉列表。选择 g++ 生成和调试活动文件。

C++ debug configuration dropdown

VS Code 创建一个 launch.json 文件，该文件看起来类似于这样

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "C/C++: g++ build and debug active file",
      "type": "cppdbg",
      "request": "launch",
      "program": "${fileDirname}/${fileBasenameNoExtension}",
      "args": [],
      "stopAtEntry": false,
      "cwd": "${workspaceFolder}",
      "environment": [],
      "externalConsole": false,
      "MIMode": "gdb",
      "miDebuggerPath": "/usr/bin/gdb",
      "setupCommands": [
        {
          "description": "Enable pretty-printing for gdb",
          "text": "-enable-pretty-printing",
          "ignoreFailures": true
        }
      ],
      "preLaunchTask": "C/C++: g++ build active file"
    }
  ]
}

在上面的 JSON 中，program 指定您要调试的程序。此处将其设置为活动文件文件夹 ${fileDirname} 和不带扩展名的活动文件名 ${fileBasenameNoExtension}，如果 helloworld.cpp 是活动文件，则为 helloworld。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": "Linux",
      "includePath": ["${workspaceFolder}/**"],
      "defines": [],
      "compilerPath": "/usr/bin/gcc",
      "cStandard": "c11",
      "cppStandard": "c++17",
      "intelliSenseMode": "clang-x64"
    }
  ],
  "version": 4
}

关闭 WSL 会话

当您在 WSL 中完成工作后，您可以使用主 文件 菜单和命令面板（⇧⌘P（Windows、Linux Ctrl+Shift+P））中提供的 关闭远程连接 命令关闭远程会话。这将重新启动在本地运行的 VS Code。您可以从 文件 > 打开最近 列表中轻松地重新打开您的 WSL 会话，方法是选择带有 [WSL] 后缀的文件夹。

后续步骤

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