Visual Studio Code

在Visual Studio Code中使用Clang

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

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

如果您有任何问题，请随时在本教程的VS Code 文档仓库中提交问题。

先决条件

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

  1. 安装 Visual Studio Code on macOS.

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

    C/C++ 扩展

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

文件资源管理器

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

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

探索 IntelliSense

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

要查看IntelliSense的实际效果，请将鼠标悬停在vector或string上以查看它们的类型信息。如果您在第10行输入msg.，您可以看到推荐的成员函数调用的完成列表，所有这些都由IntelliSense生成：

语句完成智能感知

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

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

运行 helloworld.cpp

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

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

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

    helloworld.cpp 和播放按钮的截图

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

    构建和调试任务

你只需要在第一次运行helloworld.cpp时选择一个编译器。这个编译器是在tasks.json文件中设置的“默认”编译器。

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

    程序输出的截图

恭喜！您刚刚在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在当前行设置断点。

    helloworld.cpp中的断点截图

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

    播放按钮下拉菜单的截图

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

    构建和调试任务

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

    你好世界终端输出

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

探索调试器

在开始逐步查看代码之前，让我们花点时间注意用户界面中的几个变化：

  • 集成终端出现在源代码编辑器的底部。在调试控制台标签中，您会看到指示调试器已启动并正在运行的输出。

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

    初始断点

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

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

    调试控制

逐步执行代码

现在你已经准备好开始逐步执行代码了。

  1. 在调试控制面板中选择Step over图标，以便for (const string& word : msg)语句被高亮显示。

    跳过按钮

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

  2. 再次按下Step over以前进到下一个语句（跳过所有用于初始化循环的内部代码）。现在，Variables窗口显示了关于循环变量的信息。

  3. 再次按下Step over以执行cout语句。

  4. 如果你愿意，你可以一直按Step over，直到向量中的所有单词都被打印到控制台。但如果你好奇，试试按Step Into按钮，逐步查看C++标准库中的源代码！

设置监视

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

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

    监视窗口

    注意: 监视变量的值仅在程序执行处于变量作用域内时可用。例如，对于循环变量，该值仅在程序执行循环时可用。

  2. 在循环之前添加另一个监视，通过添加这个语句：int i = 0;。然后，在循环内部，添加这个语句：++i;。现在像上一步一样为i添加一个监视。

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

    鼠标悬停

使用 launch.json 自定义调试

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

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

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

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

然后你会看到一个下拉菜单，其中包含各种预定义的调试配置。选择C/C++: clang++ 构建并调试活动文件。 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）等。

通过从命令面板运行命令C/C++: 编辑配置 (UI)来查看C/C++配置界面（⇧⌘P (Windows, Linux Ctrl+Shift+P)）。

命令面板

这将打开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": "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中使用的初始化。确保将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": []
}

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

一旦你接受了权限请求，那么在调试时外部控制台应该会出现。

下一步

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