在 Visual Studio Code 中使用 Clang

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

配置 VS Code 后，您将在 VS Code 中编译和调试一个 C++ 程序。本教程不会向您介绍 Clang 或 C++ 语言。对于这些主题，Web 上有许多好的资源可用。

如果您有任何问题，请随时在 VS Code 文档存储库中为此教程提交问题。

先决条件

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

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

确保已安装 Clang

Clang 可能已安装在您的 Mac 上。要验证是否已安装，请打开一个 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 配置。从编译器下拉列表中，选择 使用 clang++ 进行配置。更多信息可以在 IntelliSense 配置文档中找到。

运行 helloworld.cpp

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

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

系统仅在您第一次运行 helloworld.cpp 时要求您选择编译器。此编译器是设置在 tasks.json 文件中的“默认”编译器。

构建成功后，您的程序的输出将显示在集成的 Debug Console（调试控制台）中。

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

了解 tasks.json

首次运行程序时，C++ 扩展会创建 tasks.json 文件，该文件位于项目的 .vscode 文件夹中。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}）中创建一个与活动文件同名但没有文件扩展名（${fileBasenameNoExtension}）的输出文件（-o 开关）。此过程创建 helloworld。

label 值是您在任务列表中看到的内容，它基于您的个人偏好。

detail 值是任务列表中任务的描述。更新此字符串以区分与其他类似任务。

problemMatcher 值选择用于查找编译器输出中错误和警告的输出解析器。对于 clang++，$gcc 问题匹配器会产生最佳结果。

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

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

替换为

    "group": "build",

修改 tasks.json

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

调试 helloworld.cpp

要调试你的代码，

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

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

探索调试器

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

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

单步调试代码

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

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

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

设置监视

您可能希望在程序执行过程中跟踪变量的值。您可以通过对变量设置 watch（监视）来实现此目的。

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

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

使用 launch.json 自定义调试

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

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

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

Add debug configuration play button menu

然后，您将看到一个用于各种预定义调试配置的下拉列表。选择 C/C++: clang++ 构建并调试活动文件。 C++ debug configuration dropdown

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++: 编辑配置 (UI) 来查看 C/C++ 配置 UI。

Command Palette

这将打开 C/C++ Configurations（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
}

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

编译器路径

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

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

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

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

Mac 框架路径

在 C/C++ 配置屏幕上，向下滚动并展开 Advanced Settings（高级设置），并确保 Mac framework path（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 中使用的初始化。请确保将 tasks.json 文件的全部内容替换为运行 helloworld.cpp 部分中提供的代码块。

终端无法启动以进行输入

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

12/14/2023