在 VS Code 中使用 Linux 上的 C++

在本教程中，您将配置 Visual Studio Code 以在 Linux 上使用 GCC C++ 编译器 (g++) 和 GDB 调试器。GCC 代表 GNU 编译器集合；GDB 是 GNU 调试器。

配置完 VS Code 后，您将在 VS Code 中编译和调试一个简单的 C++ 程序。本教程不会教您 GCC、GDB、Ubuntu 或 C++ 语言。对于这些主题，网上有很多好的资源可用。

如果您遇到问题，请随时在 VS Code 文档存储库 中为本教程提交问题。

先决条件

要成功完成本教程，您必须执行以下操作

1. 安装 Visual Studio Code.

2. 安装 适用于 VS Code 的 C++ 扩展。您可以在扩展视图中搜索“c++”来安装 C/C++ 扩展（⇧⌘X (Windows、Linux Ctrl+Shift+X)）。

   

确保已安装 GCC

虽然您将使用 VS Code 编辑源代码，但您将在 Linux 上使用 g++ 编译器编译源代码。您还将使用 GDB 进行调试。这些工具在 Ubuntu 上默认未安装，因此您必须安装它们。幸运的是，这很容易。

首先，检查是否已安装 GCC。要验证是否已安装，请打开一个终端窗口并输入以下命令

gcc -v

如果未安装 GCC，请从终端窗口运行以下命令以更新 Ubuntu 包列表。过时的 Linux 发行版有时会干扰安装新包的尝试。

sudo apt-get update

接下来，使用以下命令安装 GNU 编译器工具和 GDB 调试器

sudo apt-get install build-essential gdb

创建 Hello World

从终端窗口中，创建一个名为 projects 的空文件夹来存储您的 VS Code 项目。然后创建一个名为 helloworld 的子文件夹，导航到该子文件夹，并通过输入以下命令在该文件夹中打开 VS Code

mkdir projects
cd projects
mkdir helloworld
cd helloworld
code .

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

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

添加 Hello World 源代码文件

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

粘贴以下源代码

#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;

    return 0;
}

现在按 ⌘S (Windows、Linux Ctrl+S) 保存文件。请注意，您的文件列在 VS Code 侧边栏中的文件资源管理器视图中（⇧⌘E (Windows、Linux Ctrl+Shift+E)）。

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

Visual Studio Code 边缘的活动栏可让您打开不同的视图，例如搜索、源代码管理和运行。您将在本教程的后面部分查看运行视图。您可以在 VS Code 用户界面文档 中详细了解其他视图。

注意：保存或打开 C++ 文件时，您可能会收到来自 C/C++ 扩展的有关 Insiders 版本可用性的通知，该版本可让您测试新功能和修复。您可以通过选择X（清除通知）来忽略此通知。

探索 IntelliSense

在 helloworld.cpp 文件中，将鼠标悬停在 vector 或 string 上以查看类型信息。在声明 msg 变量后，开始键入 msg.，就像您在调用成员函数时一样。您应该立即看到一个显示所有成员函数的完成列表，以及一个显示 msg 对象类型信息的窗口。

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

运行 helloworld.cpp

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

1. 打开 helloworld.cpp 以使其成为活动文件。

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

   

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

   

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

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

   

您第一次运行程序时，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 来设置断点。
3. 从播放按钮旁边的下拉菜单中选择 **调试 C/C++ 文件**。
4. 从系统中检测到的编译器列表中选择 **C/C++: g++ 构建和调试活动文件**（只有在第一次运行或调试 helloworld.cpp 时才会提示你选择编译器）。

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

探索调试器

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

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

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

  

• 左侧的 **运行和调试** 视图显示调试信息。你将在本教程后面的内容中看到一个示例。

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

  

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

单步执行代码

现在你就可以开始单步执行代码了。

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

   

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

   

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

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

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

   

   要返回到自己的代码，一种方法是继续按下 **单步跳过**。另一种方法是在代码中设置一个断点，方法是切换到代码编辑器中的 helloworld.cpp 选项卡，将插入点放在循环内部的 cout 语句上的某个位置，然后按下 F9。左侧边距中将出现一个红色点，表示已在该行设置了断点。

   

   然后按下 F5 从标准库头文件中的当前行开始执行。执行将在 cout 处中断。如果你愿意，可以再次按下 F9 以切换断点。

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

   

设置监视

要跟踪程序执行过程中变量的值，请对变量设置一个 **监视器**。

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

   

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

   

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

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

使用 launch.json 自定义调试

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

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

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

然后你会看到一个包含各种预定义调试配置的下拉菜单。选择 **g++ 构建和调试活动文件**。

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。

这将打开 **C/C++ 配置** 页面。当你在此处进行更改时，VS Code 会将它们写入 .vscode 文件夹中的名为 c_cpp_properties.json 的文件。

只有在你的程序包含不在你的工作区或标准库路径中的头文件时，你才需要修改 **包含路径** 设置。

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
}

重复使用 C++ 配置

VS Code 现在已配置为在 Linux 上使用 gcc。该配置适用于当前工作区。要重复使用该配置，只需将 JSON 文件复制到新项目文件夹（工作区）中的 .vscode 文件夹中，并根据需要更改源文件和可执行文件的文件名。

故障排除

编译器和链接错误

错误的最常见原因（例如 undefined _main 或 attempting to link with file built for unknown-unsupported file format 等）是当你开始构建或开始调试时，helloworld.cpp 不是活动文件。这是因为编译器正在尝试编译一些不是源代码的东西，例如你的 launch.json、tasks.json 或 c_cpp_properties.json 文件。

后续步骤

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