编辑

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

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

配置 VS Code 后，你将在 VS Code 中编译和调试一个简单的 C++ 程序。本教程不教授 GCC、GDB、Ubuntu 或 C++ 语言。关于这些主题，网络上有许多优秀的资源。

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

先决条件

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

安装 Visual Studio Code。
安装 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)) 中列出

File Explorer

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

Visual Studio Code 边缘的活动栏允许你打开不同的视图，例如“搜索”、“源代码管理”和“运行”。你将在本教程的后面部分查看“运行”视图。你可以在 VS Code 用户界面文档中找到有关其他视图的更多信息。

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

探索 IntelliSense

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

Statement completion IntelliSense

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

运行 helloworld.cpp

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

打开 helloworld.cpp，使其成为活动文件。
按编辑器右上角的播放按钮。
从系统上检测到的编译器列表中选择“g++ 生成和调试活动文件”。

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

构建成功后，你的程序输出将出现在集成终端中。

首次运行程序时，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 以构建多个 C++ 文件，方法是使用类似 "${workspaceFolder}/*.cpp" 而不是 "${file}" 的参数。这将构建当前文件夹中的所有 .cpp 文件。你还可以通过将 "${fileDirname}/${fileBasenameNoExtension}" 替换为硬编码的文件名（例如 'helloworld.out'）来修改输出文件名。

调试 helloworld.cpp

要调试你的代码，

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

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

探索调试器

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

集成终端出现在源代码编辑器的底部。“调试输出”选项卡中，你看到指示调试器正在运行的输出。
编辑器突出显示第 12 行，这是你在启动调试器之前设置的断点
左侧的“运行和调试”视图显示调试信息。你将在本教程的后面部分看到一个示例。
在代码编辑器的顶部，会出现一个调试控制面板。你可以通过抓住左侧的点在屏幕上移动它。

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

单步执行代码

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

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

这将使程序执行前进到 for 循环的第一行，并跳过在创建和初始化 msg 变量时调用的 vector 和 string 类中的所有内部函数调用。请注意侧面的“变量”窗口中的变化。
再次按“单步跳过”以前进到此程序中的下一个语句（跳过所有为初始化循环而执行的内部代码）。现在，“变量”窗口显示有关循环变量的信息。
再次按“单步跳过”以执行 cout 语句。（请注意，在最后一个 cout 执行之前，C++ 扩展不会将任何输出打印到调试控制台。）
如果你愿意，你可以继续按“单步跳过”，直到向量中的所有单词都打印到控制台。但是如果你感到好奇，请尝试按“单步进入”按钮来单步执行 C++ 标准库中的源代码！

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

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

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

设置监视

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

将插入点放在循环内。在“监视”窗口中，单击加号，然后在文本框中键入 word，这是循环变量的名称。现在在单步执行循环时查看“监视”窗口。
要在执行在断点处暂停时快速查看任何变量的值，你可以将鼠标指针悬停在其上方。

接下来，你将创建一个 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 的文件。

IntelliSense configuration window

如果你的程序包含不在你的工作区或标准库路径中的头文件，你只需要修改“包含路径”设置。

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

5/13/2022