在 Visual Studio Code 中使用 Clang

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

配置好 VS Code 后，您将在 VS Code 中编译并调试一个 C++ 程序。本教程不教授有关 Clang 或 C++ 语言本身的知识。对于这些主题，网络上有许多优秀的资源可供参考。

如果您遇到任何问题，欢迎在 VS Code 文档仓库中为此教程提交议题。

先决条件

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

安装 macOS 版 Visual Studio Code。
安装 VS Code 的 C++ 扩展。您可以通过在扩展视图（⇧⌘X (Windows, Linux Ctrl+Shift+X)）中搜索“C++”来安装 C/C++ 扩展。

确保已安装 Clang

您的 Mac 可能已经安装了 Clang。要验证这一点，请打开 macOS 终端窗口并输入以下命令：

clang --version

如果未安装 Clang，请输入以下命令安装包含 Clang 在内的命令行开发者工具：

xcode-select --install

创建 Hello World 应用程序

从 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)）中。

File Explorer

您还可以通过选择文件 > 自动保存来启用自动保存，以便自动保存文件更改。您可以在 VS Code 用户界面文档中找到有关其他视图的更多信息。

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

探索 IntelliSense

IntelliSense 是一款工具，通过添加代码编辑功能（如代码补全、参数信息、快速信息和成员列表），帮助您更快速、更高效地编写代码。

要查看 IntelliSense 的实际效果，请将鼠标悬停在 vector 或 string 上以查看它们的类型信息。如果您在第 10 行输入 msg.，您可以看到由 IntelliSense 生成的建议调用的成员函数补全列表。

Statement completion IntelliSense

您可以按下 Tab 键插入所选成员。然后，当您添加左括号时，系统会显示该函数所需参数的相关信息。

如果尚未配置 IntelliSense，请打开命令面板（⇧⌘P (Windows, Linux Ctrl+Shift+P)）并输入选择 IntelliSense 配置。从编译器下拉列表中，选择 Use clang++ 进行配置。更多信息可在 IntelliSense 配置文档中找到。

运行 helloworld.cpp

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

打开 helloworld.cpp，使其成为活动文件。
单击编辑器右上角的播放按钮。
从系统中检测到的编译器列表中选择C/C++: clang++ build and debug active file。

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

构建成功后，程序的输出将出现在集成的调试控制台中。

恭喜！您刚刚在 VS Code 中运行了您的第一个 C++ 程序！

理解 tasks.json

当您第一次运行程序时，C++ 扩展会创建位于项目 .vscode 文件夹中的 tasks.json。tasks.json 存储了构建配置。

以下是 macOS 上 tasks.json 文件的示例

{
  "tasks": [
    {
      "type": "cppbuild",
      "label": "C/C++: clang++ build active file",
      "command": "/usr/bin/clang++",
      "args": [
        "-fcolor-diagnostics",
        "-fansi-escape-codes",
        "-g",
        "${file}",
        "-o",
        "${fileDirname}/${fileBasenameNoExtension}"
      ],
      "options": {
        "cwd": "${fileDirname}"
      },
      "problemMatcher": ["$gcc"],
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "detail": "Task generated by Debugger."
    }
  ],
  "version": "2.0.0"
}

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

command 设置指定要运行的程序。在本例中，即 clang++。

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

此任务指示 C++ 编译器获取活动文件 (${file})，对其进行编译，并在当前目录 (${fileDirname}) 中创建一个输出文件 (-o 开关)，其名称与活动文件相同但没有文件扩展名 (${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" 而非 "${file}"）来构建多个 C++ 文件。这会构建当前文件夹中的所有 .cpp 文件。您还可以通过将 "${fileDirname}/${fileBasenameNoExtension}" 替换为硬编码文件名（例如 "${workspaceFolder}/myProgram.out"）来修改输出文件名。

调试 helloworld.cpp

要调试你的代码，

回到 helloworld.cpp，使其成为活动文件。
通过点击编辑器边距或在当前行使用 F9 来设置断点。
从播放按钮旁边的下拉菜单中，选择调试 C/C++ 文件。
从系统中检测到的编译器列表中选择C/C++: clang++ build and debug active file（您仅在第一次运行或调试 helloworld.cpp 时才会被要求选择编译器）。
您将看到任务执行并将其输出打印到终端窗口。

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

探索调试器

在开始单步调试代码之前，我们花点时间注意用户界面中的几处变化

集成终端将出现在源代码编辑器的底部。在调试控制台选项卡中，您将看到表明调试器已启动并正在运行的输出。
编辑器会高亮显示你在启动调试器之前设置断点的行
活动栏中的运行和调试视图将显示调试信息。
代码编辑器顶部会出现一个调试控制面板。你可以通过抓取左侧的点来在屏幕上移动它。

单步调试代码

现在你已准备好开始单步调试代码。

在调试控制面板中选择单步跳过图标，以便突出显示 for (const string& word : msg) 语句。

单步跳过命令会跳过 vector 和 string 类中在 msg 变量创建和初始化时调用的所有内部函数调用。请注意变量窗口中的变化。由于该语句已完成，msg 的内容已可见。
再次按下单步跳过以前进到下一条语句（跳过为初始化循环而执行的所有内部代码）。现在，变量窗口显示了有关循环变量的信息。
再次按下单步跳过以执行 cout 语句。
如果你愿意，可以继续按单步跳过，直到向量中的所有单词都打印到控制台。但如果你好奇，可以尝试按单步进入按钮来单步执行 C++ 标准库中的源代码！

设置监视

您可能希望在程序执行时跟踪某个变量的值。您可以通过在该变量上设置监视来实现。

在监视窗口中，选择加号并在文本框中输入 word。这是循环变量的名称。现在，当您单步执行循环时，请查看监视窗口。

注意：监视变量的值仅在程序执行处于该变量的作用域内时才可用。例如，对于循环变量，仅在程序执行循环时该值才可用。
通过在循环前添加此语句来添加另一个监视：int i = 0;。然后，在循环内部添加此语句：++i;。现在，像上一步一样为 i 添加监视。
当执行暂停时，您可以将鼠标指针悬停在任何变量上，以快速查看其值。

使用 launch.json 自定义调试

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

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

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

Add debug configuration play button menu

然后，您将看到各种预定义调试配置的下拉菜单。选择C/C++: clang++ build and debug active file。 C++ 调试配置下拉菜单

VS Code 创建一个 launch.json 文件，它看起来像这样

{
  "configurations": [
    {
      "name": "C/C++: clang++ build and debug active file",
      "type": "cppdbg",
      "request": "launch",
      "program": "${fileDirname}/${fileBasenameNoExtension}",
      "args": [],
      "stopAtEntry": false,
      "cwd": "${fileDirname}",
      "environment": [],
      "externalConsole": false,
      "MIMode": "lldb",
      "preLaunchTask": "C/C++: clang++ build active file"
    }
  ],
  "version": "2.0.0"
}

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

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

将 stopAtEntry 值更改为 true，以便在开始调试时让调试器在 main 方法处停止。

确保 preLaunchTask 值与 tasks.json 文件中构建任务的 label 相匹配。

从现在开始，播放按钮和 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++ 配置界面。

Command Palette

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

C++ configuration

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": "macos-clang-arm64"
    }
  ],
  "version": 4
}

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

编译器路径

扩展使用 compilerPath 设置来推断 C++ 标准库头文件的路径。当扩展知道去哪里查找这些文件时，它就可以提供诸如智能补全和转到定义导航等功能。

C/C++ 扩展会根据系统上找到的内容，尝试使用默认编译器位置来填充 compilerPath。compilerPath 的搜索顺序为：

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

更多信息，请参阅 IntelliSense 配置文档。

Mac 框架路径

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

故障排除

编译器和链接错误

最常见的错误原因（例如 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++ 参数 --std=c++17。默认情况下，clang++ 使用 C++98 标准，该标准不支持 helloworld.cpp 中使用的初始化方式。请务必用运行 helloworld.cpp 一节中提供的代码块替换整个 tasks.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": []
}

您可以使用终端 > 运行任务...并选择Open Terminal来运行此特定任务。

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

后续步骤

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

12/14/2023