在 VS Code 中尝试

在 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++ 语言。对于这些主题,Web 上有许多优秀的资源。

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

先决条件

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

  1. 安装 Visual Studio Code

  2. 安装 VS Code 的 C++ 扩展。您可以通过在“扩展”视图中搜索“c++”来安装 C/C++ 扩展(⇧⌘X (Windows, Linux Ctrl+Shift+X))。

    C/C++ extension

确保已安装 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

New File title bar button

粘贴以下源代码:

#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 文件中,将鼠标悬停在 vectorstring 上以查看类型信息。在声明 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

您可以通过使用 "${workspaceFolder}/*.cpp" 代替 "${file}" 等参数来修改 tasks.json 以构建多个 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 变量时调用的 vectorstring 类中的所有内部函数调用。注意侧面变量窗口中的变化。

    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 是活动文件,则将是 helloworldargs 属性是一个数组,包含在运行时传递给程序的参数。

默认情况下,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 _mainattempting to link with file built for unknown-unsupported file format 等)发生在您开始构建或调试时 helloworld.cpp 不是活动文件。这是因为编译器试图编译一些不是源代码的文件,例如您的 launch.jsontasks.jsonc_cpp_properties.json 文件。

后续步骤

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