在 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++ 编译器编译源代码。你还将使用 GDB 在 Linux 上进行调试。这些工具在 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 命令未返回文件名，请尝试再次运行更新命令。

    whereis g++
whereis gdb

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

在 WSL 中运行 VS Code

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

cd $HOME/projects/helloworld
code .

你将看到一条关于“正在安装 VS Code 服务器”的消息。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 (编译器路径和智能感知设置)
  • 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 用户界面文档中找到有关其他视图的更多信息。

探索智能感知

在新的 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

你可以修改 `tasks.json`，通过使用类似 "${workspaceFolder}/*.cpp" 的参数而不是 "${file}" 来构建多个 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