在 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++ 扩展。您可以在扩展视图 (⇧⌘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)) 中

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

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

探索 IntelliSense

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

要查看 IntelliSense 的实际效果，请将鼠标悬停在 vector 或 string 上以查看其类型信息。如果在第 10 行中键入 msg.，您将看到一个包含推荐的成员函数的补全列表，这些列表全部由 IntelliSense 生成

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

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

运行 helloworld.cpp

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

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

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

   

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

   

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

4. 构建成功后，程序的输出将显示在集成的“调试控制台”中。

   

恭喜！您刚刚在 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}) 中创建输出文件 (-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" 的参数来构建多个 C++ 文件，而不是使用 "${file}"。这将构建当前文件夹中的所有 .cpp 文件。您也可以通过将 "${fileDirname}/${fileBasenameNoExtension}" 替换为硬编码文件名（例如 "${workspaceFolder}/myProgram.out"）来修改输出文件名。

调试 helloworld.cpp

要调试您的代码，

1. 返回 helloworld.cpp 使其成为活动文件。

2. 通过单击编辑器边距或在当前行使用 F9 设置断点。

   

3. 从播放按钮旁边的下拉菜单中选择 **调试 C/C++ 文件**。

   

4. 从系统上检测到的编译器列表中选择 **C/C++: clang++ 构建并调试活动文件**（您只需要在第一次运行或调试 helloworld.cpp 时选择一个编译器）。

   

5. 您将看到任务执行并将输出打印到 **终端** 窗口。

   

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

探索调试器

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

• 集成终端出现在源代码编辑器的底部。在 **调试控制台** 选项卡中，您会看到指示调试器正在运行的输出。

• 编辑器突出显示您在启动调试器之前设置断点的那一行

  

• **运行和调试** 视图在活动栏中显示调试信息。

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

  

逐步执行代码

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

1. 选择调试控制面板中的 **单步执行** 图标，使 for (const string& word : msg) 语句高亮显示。

   

   **单步执行** 命令跳过 vector 和 string 类中创建和初始化 msg 变量时调用的所有内部函数调用。注意 **变量** 窗口的变化。msg 的内容是可见的，因为该语句已完成。

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

3. 再次按 **单步执行** 以执行 cout 语句。

4. 如果您愿意，您可以继续按 **单步执行**，直到向量中的所有单词都打印到控制台。但如果您好奇，请尝试按 **单步进入** 按钮以逐步执行 C++ 标准库中的源代码！

设置监视

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

1. 在 **监视** 窗口中，选择加号并在文本框中键入 word。这是循环变量的名称。现在，在逐步执行循环时查看 **监视** 窗口。

   

   **注意**：监视变量的值仅在程序执行在变量范围内时可用。例如，对于循环变量，该值仅在程序执行循环时可用。

2. 通过在循环之前添加以下语句来添加另一个监视：int i = 0;。然后，在循环中，添加以下语句：++i;。现在，在执行上一步操作时添加对 i 的监视。

3. 执行暂停时，您可以将鼠标指针悬停在任何变量上以快速查看其值。

   

使用 launch.json 自定义调试

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

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

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

然后您将看到一个包含各种预定义调试配置的下拉菜单。选择 **C/C++: clang++ 构建并调试活动文件**。

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_cpp_properties.json 文件，该文件允许您更改设置，例如编译器的路径、包含路径、要编译的 C++ 标准（例如 C++17）等等。

从命令面板 (⇧⌘P（Windows、Linux Ctrl+Shift+P）) 运行命令 **C/C++: 编辑配置 (UI)** 以查看 C/C++ 配置 UI。

这将打开 **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": "macos-clang-arm64"
    }
  ],
  "version": 4
}

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

编译器路径

扩展使用 compilerPath 设置来推断 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": []
}

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

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

后续步骤

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