本站点文档内容均翻译自code.visualstudio.com，仅供个人学习，如有差异请以官网为准。

使用 C++ 和 WSL 在 VS Code 中

在这个教程中，你将配置Visual Studio Code使用GCC C++编译器（g++）和GDB调试器在Ubuntu中Windows子系统中的Linux（WSL）。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++ 语言的知识。对于这些主题，网络上有很多优质的资源。

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

先决条件

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

  1. 安装Visual Studio Code.

  2. 安装WSL扩展。

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

设置您的 Linux 环境

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

    开始菜单中的 Ubuntu

    当您输入命令后，外壳会显示一个命令提示符，该提示符默认由您的用户名和计算机名称组成，并将您置于您的主目录中。对于 Ubuntu，它看起来像这样：

    Bash Shell

  2. 创建一个名为的目录项目然后在那下面有一个子目录叫做Hello World输入：

    创建目录 项目
进入目录 项目
创建目录 你好世界

  3. 虽然你会使用 VS Code 来编辑你的源代码，但你会在 Linux 上使用 g++ 编译器来编译源代码。你还会在 Linux 上使用 GDB 来进行调试。这些工具在 Ubuntu 上默认没有安装，所以你需要安装它们。幸运的是，这个任务非常简单！

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

    超级用户 软件包管理工具 更新

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

  5. 在命令提示符下，输入以下命令安装GNU编译器工具和GDB调试器：

    超级用户权限 软件包管理工具 安装 编译工具包 调试器

  6. 通过查找g++和gdb来验证安装是否成功。如果文件名没有从哪里命令，再试一次更新命令。

    哪里 g++
哪里 gdb

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

在WSL中运行VS Code

导航到你的helloworld项目文件夹，并在WSL终端中启动VS Code代码输入：

cd $HOME/projects/helloworld
code .

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

WSL中的文件资源管理器

您还可以从状态栏中识别远程上下文。

状态栏中的远程上下文

如果你点击远程状态栏项目，你将看到一个适用于该会话的远程命令下拉菜单。例如，如果你想终止在WSL中运行的会话，可以从下拉菜单中选择关闭远程连接命令。运行代码从你的WSL命令提示符将重启在WSL中运行的VS Code。

代码命令在当前工作文件夹中打开了 VS Code，这将成为你的"工作区"。随着你完成教程，你将看到三个文件在.vscode工作区中的文件夹：

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

添加源代码文件

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

新建文件 标题栏 按钮

安装 C/C++ 扩展

一旦你创建了文件，VS Code检测到这是一个C++语言文件，如果没有安装Microsoft C/C++扩展，你可能会被提示进行安装。

C++ 扩展通知

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

如果你已经在 VS Code 中的本地安装了 C/C++ 语言扩展，你需要进入扩展视图 (⇧⌘X (Windows, Linux Ctrl+Shift+X)) 并将这些扩展安装到 WSL 中。本地安装的扩展可以通过选择 Install in WSL 按钮并然后 Reload Required 来安装到 WSL 中。

在WSL按钮中安装

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

文件资源管理器

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

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

探索IntelliSense

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

语句完成IntelliSense

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

运行 helloworld.cpp

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

  1. 打开helloworld.cpp这样它就是活动文件。

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

    helloworld.cpp的截图和播放按钮

  3. 选择 g++ 编译和调试当前文件 从系统上检测到的编译器列表中。

    C++ 调试配置下拉菜单

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

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

    程序输出的截图

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

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

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

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

这个任务告诉g++使用当前活动的文件 (${文件})，编译它，并在当前目录创建一个可执行文件（${文件目录}) 与活动文件同名但没有扩展名 (${文件名无扩展名})，导致Hello World例如我们的例子。

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

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

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

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

用这个：

    "组": "构建",

修改 tasks.json

您可以修改您的任务.json通过使用像这样的参数来编译多个 C++ 文件"${workspaceFolder}/*.cpp"而不是"${file}"这将构建所有.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行，这是你在启动调试器之前设置的断点：

    初始断点

  • 左侧面板的运行和调试视图显示调试信息。您稍后会在教程中看到一个示例。

  • 在代码编辑器的顶部，出现了一个调试控制面板。你可以通过抓取左侧的点来在屏幕上移动这个面板。

    调试控制

如果你的工程目录下已经有 launch.json 文件，播放按钮将读取它来决定如何运行和调试你的 C++ 文件。如果你没有 launch.json 文件，播放按钮将实时创建一个临时的“快速调试”配置，完全消除对 launch.json 的需求！

逐步执行代码

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

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

    跳过按钮

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

    调试Windows

  2. 按 单步执行 再次以跳过所有执行的内部代码，转到此程序的下一条语句。现在，变量 Windows显示有关循环变量的信息。

  3. 按 单步执行 再次执行 输出流对象 语句。(请注意，C++ 扩展在最后的 cout 执行之前不会在调试控制台中打印任何输出。)

  4. 如果你愿意，你可以继续按单步执行，直到向量中的所有单词都打印到控制台。但如果你很好奇，可以按单步进入按钮，逐步执行C++标准库的源代码！

    在gcc标准库头文件中的断点

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

    主程序中的断点

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

    当循环完成时，您可以在调试控制台标签页的集成终端中看到输出，以及GDB输出的一些其他诊断信息。

    调试控制台显示

设置闹钟

为了跟踪程序执行过程中变量的值，请在该变量上设置监视点。

  1. 将插入点置于循环内。在监视Windows中，点击加号并在文本框中输入单词，这是循环变量的名称。现在在逐步执行循环时查看观察Windows。

    观看Windows

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

    鼠标悬停

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

拥有它是很重要的helloworld.cpp在编辑器中打开，因为下一步将使用编辑器中的当前文件作为上下文来创建构建任务。

使用 launch.json 自定义调试

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

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

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

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

然后你会看到一个下拉菜单，用于各种预定义的调试配置。选择g++ 构建并调试当前文件。

C++ 调试配置下拉菜单

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": "启用gdb的美化打印",
          "text": "-enable-pretty-printing",
          "ignoreFailures": true
        }
      ],
      "preLaunchTask": "C/C++: g++ 构建当前文件"
    }
  ]
}

在上面的JSON中，程序指定您要调试的程序。这里设置为当前活动的文件夹${文件目录}和活动的文件名没有扩展名${文件名无扩展名}，如果helloworld.cpp将是活动文件Hello World。参数属性是传递给程序的运行时参数数组。

默认情况下，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": "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文件复制到其中，调整新的工作区路径、程序名称等必要的设置，然后开始编码！