在 VS Code 中使用 C++ 和 WSL

在本教程中，您将配置Visual Studio Code，使其在Windows子系统Linux（WSL）中使用G99的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++语言的内容。对于这些主题，网上有许多优质资源。

如果你有任何问题，欢迎在VS Code文档库中提交本教程的问题。

前提条件

要成功完成本教程，你必须完成以下步骤：

  1. 安装Visual Studio Code。

  2. 安装WSL扩展。

  3. 安装Linux版Windows子系统，然后使用同一页面上的链接安装你喜欢的Linux发行版。这个教程使用了Ubuntu。安装时请记住你的Linux用户密码，因为你需要它来安装额外的软件。

搭建你的Linux环境

  1. 打开Bash外壳玩WSL。如果你安装了 Ubuntu 发行版，在 Windows 搜索框输入“Ubuntu”，然后点击结果列表。对于Debian，输入“Debian”，依此类推。

    开始菜单中的Ubuntu页面

    shell 会带着一个命令提示符出现，默认包含你的用户名和电脑名，并将你放到你的主目录中。对于Ubuntu来说，情况如下：

    巴什壳

  2. 创建一个名为项目然后在 下面有一个子目录，称为HelloWorld:

    mkdir projects
cd projects
mkdir helloworld

  3. 虽然你会用 VS Code 编辑源代码，但你会用 Linux 的 g++ 编译器编译源代码。你还会用 GDB 在 Linux 上调试。这些工具在Ubuntu上默认不安装，所以你必须安装它们。幸运的是，这个任务相当简单！

  4. 在WSL命令提示符中，首次运行APT-Get 更新以更新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 g++
whereis gdb

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

在WSL中运行VS Code。

进入你的helloworld项目文件夹，并从WSL终端启动VS Code，代码。:

cd $HOME/projects/helloworld
code .

你会看到一个关于“安装VS Code Server”的提示。VS Code 是在 Linux 端下载并安装一个小型服务器，桌面 VS Code 会与它通信。VS Code 随后会启动并打开helloWorld文件夹。文件资源管理器显示VS Code现在在WSL上下文中运行，标题栏为WSL： Ubuntu。

WSL 中的文件资源管理器

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

状态栏中的远程上下文

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

代码 .命令在当前工作文件夹中打开了VS Code，那里就成了你的“工作区”。在教程中，你会看到三个文件被创建在.vscode工作区中的文件夹：

  • c_cpp_properties.json（编译器路径和IntelliSense设置）
  • tasks.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中。本地安装的扩展可以通过选择“安装在 WSL 中”按钮然后“重新加载”来安装到 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）保存文件。注意你刚添加的文件在VS Code侧边栏的文件资源管理器视图（⇧⌘E（Windows，Linux Ctrl+Shift+E））中显示的样子：

文件资源管理器

你也可以在主文件菜单中选择“自动保存”，启用自动保存，自动保存文件更改。

最左边的活动栏可以打开不同的视图，比如搜索、源代码控制和运行。你会在本教程后面看到“运行”视图。你可以在 VS Code 用户界面文档中了解更多关于其他视图的信息。

探索IntelliSense

在你的新helloworld.cpp档案，悬停在上向量或弦查看类型信息。在味精变量，开始输入MSG。就像调用成员函数时那样。你应该会立刻看到一个完备列表，显示所有成员函数，以及一个窗口显示味精主题：

语句补全 IntelliSense

你可以按Tab键插入选中的成员;然后，当你加上开头括号时，你会看到函数所需的参数信息。

快跑，helloworld.cpp

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

  1. 开门helloworld.cpp所以它是活跃文件。

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

    helloworld.cpp播放按钮截图

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

    C++调试配置下拉菜单

你只有在第一次运行时才会被要求选择编译器helloworld.cpp.该编译器将被设置为“默认”编译器tasks.json档案。

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

    程序输出截图

第一次运行程序时，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变量引用中的变量。

该指挥设置指定要运行的程序;这里指的是G++。 该argsarray 指定将传递给 G++ 的命令行参数。这些参数必须按照编译器预期的顺序指定。

该任务告诉 g++ 取活动文件（${file}编译，并在当前目录中创建可执行文件（${fileDirname}）与活动文件同名但没有扩展名（${fileBasenameNoExtension}），结果为HelloWorld举个例子。

该唱片公司价值是你在任务列表中看到的;你可以随意命名。

该细节价值是你在任务列表中描述任务的部分。强烈建议重新命名该数值，以区别于类似任务。

从现在起，播放按钮将从以下内容读取tasks.json想办法构建和运行你的程序。你可以在tasks.json，标记为默认的任务将由播放按钮使用。如果你需要更改默认编译器，可以运行任务：配置默认构建任务。或者你也可以修改tasks.json文件并通过替换该段来移除默认数据：

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

附带这个：

    "group": "build",

修改tasks.json

你可以修改你的tasks.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++ 构建并调试活跃文件，从系统检测到的编译器列表中（你只有在第一次运行 ordebug 时才会被要求选择编译器helloworld.cpp).C++调试配置下拉菜单

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

探索调试器

在你开始逐步浏览代码之前，让我们花点时间注意用户界面的几处变化：

  • 集成终端显示在源代码编辑器底部。在调试输出标签中，你会看到显示调试器已启动运行的输出。

  • 编辑器会高亮第12行，这是启动调试器前设置的断点：

    初始断点

  • 左侧的运行和调试视图显示调试信息。你将在教程后面看到示例。

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

    调试控制

如果你的工作区里已经有launch.json文件，播放按钮会读取它，帮助你确定如何运行和调试C++文件。如果没有launch.json，播放按钮会实时创建临时“快速调试”配置，完全免launch.json！

逐一了解代码

现在你准备好开始逐步解析代码了。

  1. 点击或点击调试控制面板中的“Step Over”图标。

    踩踏按钮

    这将将程序执行推进到for循环的第一行，跳过所有内部函数调用向量以及弦当味精变量被创建并初始化。注意侧面变量窗口的变化。

    调试窗口

  2. 再次按 Step，进入程序中的下一个语句（跳过所有执行的初始化循环的内部代码）。现在，变量窗口显示了关于循环变量的信息。

  3. 再次按“Step”键执行考特语句。（注意，C++扩展在最后一个cout执行前不会向调试控制台输出任何输出。）

  4. 如果你愿意，可以一直按“Step Over”，直到向量中的所有单词都打印到控制台。但如果你感兴趣，可以试试按“Step Into”按钮，在C++标准库里逐步浏览源代码！

    GCC标准库头部中的断点

    回到你自己的代码，一种方法是继续按“Step over”。另一种方法是通过切换到代码设置断点，helloworld.cpp在代码编辑器中，插入点放置在考特在循环内的语句，并按下F9。左侧的排水沟中出现一个红点，表示该行已设置断点。

    主打断点

    然后按 F5 从标准库头部当前行开始执行。执行会中断于考特. 如果你愿意，可以再按一次F9来关闭断点。

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

    调试控制台显示

定个手表

为了在程序执行时跟踪变量的值，可以对该变量设置监视。

  1. 将插入点放置在环内。在“手表”窗口中，点击加号，在文本框中输入字，即循环变量的名称。现在，随着你穿过循环，查看“手表”窗口。

    手表窗口

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

    鼠标悬停

接下来，你将创建一个tasks.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": "Enable pretty-printing for gdb",
          "text": "-enable-pretty-printing",
          "ignoreFailures": true
        }
      ],
      "preLaunchTask": "C/C++: g++ build active file"
    }
  ]
}

在上述JSON中，节目指定你想调试的程序。这里设置为当前文件文件夹${fileDirname}以及无扩展名的活动文件名${fileBasenameNoExtension}，如果helloworld.cpp是活跃文件，将为HelloWorld.该args属性是运行时传递给程序的参数数组。

默认情况下，C++扩展不会为你的源代码添加任何断点，而且stopAtEntry（入口停止）值设为错误.

更改stopAtEntry（入口停止）值为确实如此以使调试器在主要角色当你开始调试时。

从现在开始，播放键和F5会从你的位置读取launch.json启动程序调试时的文件。

C/C++ 配置

如果你想对 C/C++ 扩展有更多控制，可以创建一个c_cpp_properties.json文件允许你更改设置，比如编译器路径、路径、C++标准（默认为C++17）等。

您可以通过命令面板（⇧⌘P，Windows，Linux Ctrl+Shift+P））中运行命令 C/C++： Edit Configurations （UI） 来查看 C/C++ 配置界面。

命令调色板

这会打开 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文件，调整新工作区路径、程序名称等的必要设置，然后开始编程！