在 Visual Studio Code 中使用 Clang

在本教程中，您将在 macOS 上配置 Visual Studio Code 以使用 Clang/LLVM 编译器和调试器。

配置完 VS Code 后，您将在 VS Code 中编译和调试一个简单的 C++ 程序。本教程不会教您有关 Clang 或 C++ 语言的知识。对于这些主题，网络上有许多好的资源。

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

先决条件

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

  1. 在 macOS 上安装Visual Studio Code。

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

    C/C++ 扩展

确保 Clang 已安装

您的 Mac 上可能已经安装了 Clang。要验证它是否正确，请打开 macOS 终端窗口并输入以下命令：

clang --version
  1. 如果未安装 Clang，请输入以下命令来安装命令行开发人员工具：
xcode-select --install

创建你好世界

在 macOS 终端中，创建一个名为 的空文件夹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;
}

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

文件管理器

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

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

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

探索智能感知

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

语句完成智能感知

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

运行helloworld.cpp

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

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

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

    helloworld.cpp 和播放按钮的屏幕截图

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

    构建任务

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

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

    程序输出截图

第一次运行程序时，C++ 扩展会创建tasks.json，您可以在项目的.vscode文件夹中找到它。tasks.json商店构建配置。

您的新tasks.json文件应类似于以下 JSON：

{
  // See https://go.microsoft.com/fwlink/?LinkId=733558
  // for the documentation about the tasks.json format
  "version": "2.0.0",
  "tasks": [
    {
      "type": "shell",
      "label": "C/C++: clang++ build active file",
      "command": "/usr/bin/clang++",
      "args": [
        "-std=c++17",
        "-stdlib=libc++",
        "-g",
        "${file}",
        "-o",
        "${fileDirname}/${fileBasenameNoExtension}"
      ],
      "options": {
        "cwd": "${workspaceFolder}"
      },
      "problemMatcher": ["$gcc"],
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "detail": "Task generated by Debugger."
    }
  ]
}

注意：您可以在变量参考中了解有关tasks.json变量的更多信息。

该command设置指定要运行的程序。在本例中，"clang++"是导致 Clang 编译器期望 C++ 代码并链接到 C++ 标准库的驱动程序。

该args数组指定将传递给 clang++ 的命令行参数。这些参数必须按照编译器期望的顺序指定。

此任务告诉 C++ 编译器编译活动文件 ( ${file})，并-o在当前目录 ( ${fileDirname}) 中创建一个与活动文件 ( ) 同名的输出文件 ( switch) ${fileBasenameNoExtension}，这就是helloworld我们的示例。

该label值是您将在任务列表中看到的值。随意命名。

该detail值是您将作为任务列表中的任务描述的值。强烈建议重命名该值以将其与类似任务区分开来。

该problemMatcher值选择用于在编译器输出中查找错误和警告的输出解析器。对于 clang++，如果使用问题匹配器，您将获得最佳结果$gcc。

从现在开始，播放按钮将读取tasks.json以了解如何构建和运行您的程序。您可以在 中定义多个构建任务tasks.json，并且播放按钮将使用标记为默认的任务。如果您需要更改默认编译器，您可以运行任务：配置默认构建任务。或者，您可以修改tasks.json文件并通过替换此段来删除默认值：

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

有了这个：

    "group": "build",

修改tasks.json

您可以tasks.json使用诸如"${workspaceFolder}/*.cpp"而不是 之类的参数来修改您的文件以构建多个 C++ 文件${file}。这将构建.cpp当前文件夹中的所有文件。"${fileDirname}/${fileBasenameNoExtension}"您还可以通过替换为硬编码文件名（例如）来修改输出文件名"${workspaceFolder}/myProgram.out"。

调试helloworld.cpp

要调试您的代码，

  1. 返回，helloworld.cpp使其成为活动文件。
  2. 通过单击编辑器边距或在当前行上使用 F9 设置断点。 helloworld.cpp 中断点的屏幕截图
  3. 从播放按钮旁边的下拉列表中，选择Debug C/C++ File。 播放按钮下拉菜单的屏幕截图
  4. 从系统上检测到的编译器列表中选择clang++ 构建和调试活动文件helloworld.cpp（只有在第一次运行或调试时才会要求您选择编译器）。 C++ 调试配置下拉列表

播放按钮有两种模式：运行 C/C++ 文件和调试 C/C++ 文件。它将默认为上次使用的模式。如果您在播放按钮中看到调试图标，则只需选择播放按钮即可进行调试，而无需选择下拉菜单项。

探索调试器

在开始逐步执​​行代码之前，让我们花点时间注意一下用户界面中的一些变化：

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

  • 编辑器突出显示了该方法中的第一条语句main。这是 C++ 扩展自动为您设置的断点：

    初始断点

  • 左侧的“运行和调试”视图显示调试信息。您将在本教程后面看到一个示例。

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

单步执行代码

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

  1. 单击或按调试控制面板中的“单步执行for (const string& word : msg)”图标，以使该语句突出显示。

    跨过按钮

    Step Over命令会跳过创建和初始化变量时调用的vector和类中的所有内部函数调用。请注意“变量”窗口中的变化。的内容可见，因为该语句已完成。stringmsgmsg

  2. 再次按Step over前进到下一条语句（跳过为初始化循环而执行的所有内部代码）。现在，“变量”窗口显示有关循环变量的信息。

  3. 再次按Step over执行该cout语句。注意从 2019 年 3 月版本的扩展开始，在最后一个cout完成之前，调试控制台中不会出现任何输出。

设置手表

您可能希望在程序执行时跟踪变量的值。您可以通过对变量设置监视来做到这一点。

  1. 将插入点放置在循环内。在“监视”窗口中，单击加号，然后在文本框中键入word，这是循环变量的名称。现在，当您单步执行循环时，请查看“监视”窗口。

    观察窗

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

    鼠标悬停

使用 launch.json 自定义调试

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

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

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

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

然后，您将看到各种预定义调试配置的下拉列表。选择clang++ 构建并调试活动文件。 C++ 调试配置下拉列表

VS Code 创建一个launch.json文件，如下所示：

{
  // Use IntelliSense to learn about possible attributes.
  // Hover to view descriptions of existing attributes.
  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
    {
      "name": "C/C++: clang++ build and debug active file",
      "type": "cppdbg",
      "request": "launch",
      "program": "${fileDirname}/${fileBasenameNoExtension}",
      "args": [],
      "stopAtEntry": true,
      "cwd": "${workspaceFolder}",
      "environment": [],
      "externalConsole": false,
      "MIMode": "lldb",
      "preLaunchTask": "C/C++: clang++ build active file"
    }
  ]
}

该program设置指定您要调试的程序。此处设置为活动文件夹${fileDirname}和活动文件名${fileBasenameNoExtension}，如果helloworld.cpp是活动文件则为活动文件名helloworld。该args属性是在运行时传递给程序的参数数组。

默认情况下，C++ 扩展不会向源代码添加任何断点，并且该stopAtEntry值设置为false.

将值更改stopAtEntry为以使调试器在开始调试时true停止在该方法上。main

确保该值与文件中构建任务的preLaunchTask值匹配。labeltasks.json

从现在开始，在启动程序进行调试时，播放按钮和F5将从您的launch.json文件中读取。

C/C++配置

为了更好地控制 C/C++ 扩展，请创建一个c_cpp_properties.json文件，该文件允许您更改编译器路径、包含路径、要针对哪个 C++ 标准进行编译（例如 C++17）等设置。

通过运行命令 C/C++ ：从命令面板编辑配置 (UI) ( ⇧⌘P (Windows、Linux Ctrl+Shift+P ) ) 查看 C/C++ 配置 UI。

命令面板

这将打开C/C++ 配置页面。

C++配置

Visual Studio Code 将这些设置放置在.vscode/c_cpp_properties.json. 如果直接打开该文件，它应该如下所示：

{
  "configurations": [
    {
      "name": "Mac",
      "includePath": ["${workspaceFolder}/**"],
      "defines": [],
      "macFrameworkPath": [
        "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks"
      ],
      "compilerPath": "/usr/bin/clang",
      "cStandard": "c11",
      "cppStandard": "c++17",
      "intelliSenseMode": "clang-x64"
    }
  ],
  "version": 4
}

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

编译路径

compilerPath是一个重要的配置设置。该扩展使用它来推断 C++ 标准库头文件的路径。当扩展程序知道在哪里可以找到这些文件时，它可以提供有用的功能，例如智能完成和转到定义导航。

C/C++ 扩展尝试compilerPath根据它在系统上找到的内容填充默认编译器位置。搜索compilerPath顺序是：

  • 已知编译器名称的 PATH。编译器在列表中出现的顺序取决于您的 PATH。
  • 然后搜索硬编码的Xcode路径，例如/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/

Mac框架路径

在“C/C++ 配置”屏幕上，向下滚动并展开“高级设置”，并确保Mac 框架路径指向系统头文件。例如：/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks

重用您的 C++ 配置

VS Code 现已配置为在 macOS 上使用 Clang。该配置适用于当前工作区。要重用配置，只需将 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文件。

如果您看到提及“C++11 扩展”的构建错误，则您可能尚未更新tasks.json构建任务以使用 clang++ argument --std=c++17。默认情况下，clang++ 使用 C++98 标准，该标准不支持helloworld.cpp. 确保将文件的全部内容替换为运行 helloworld.cpptasks.json部分中提供的代码块。

终端不会启动用于输入

在 macOS Catalina 及更高版本上，您可能会遇到无法输入输入的问题，即使在设置之后也是如此"externalConsole": true。将打开一个终端窗口，但实际上不允许您键入任何输入。

目前已跟踪该问题#5079。

解决方法是让 VS Code 启动一次终端。您可以通过在以下位置添加并运行此任务来完成此操作tasks.json：

{
  "label": "Open Terminal",
  "type": "shell",
  "command": "osascript -e 'tell application \"Terminal\"\ndo script \"echo hello\"\nend tell'",
  "problemMatcher": []
}

您可以使用Terminal > Run Task...运行此特定任务，然后选择Open Terminal。

一旦接受权限请求，调试时就会出现外部控制台。

下一步

  • 浏览VS Code 用户指南。
  • 查看C++ 扩展概述
  • 创建一个新工作区，将 .json 文件复制到其中，调整新工作区路径、程序名称等的必要设置，然后开始编码！
2022 年 5 月 13 日