在 VS Code 中试试 ！

在 Visual Studio Code 中使用 Clang

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

配置 VS Code 后，你将在 VS Code 中编译和调试 C++ 程序。本教程不讲解 Clang 或 C++ 语言。有关这些主题，Web 上有许多好的资源可用。

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

前提条件

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

  1. 安装 macOS 上的 Visual Studio Code。

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

    C/C++ extension

确保已安装 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。

New File title bar button

粘贴以下源代码

#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。

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

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

    Screenshot of helloworld.cpp and play button

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

    Build and debug task

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

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

    screenshot of program output

恭喜！你刚刚在 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}) 中使用与活动文件同名但没有文件扩展名 (${fileBasenameNoExtension}) 的方式创建一个输出文件 (-o 开关)。此过程创建了 helloworld。

label 值是你任务列表中看到的名称，它取决于你的个人偏好。

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

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

从现在开始，播放按钮总是从 tasks.json 中读取信息，以确定如何构建和运行程序。你可以在 tasks.json 中定义多个构建任务，标记为默认的任务就是播放按钮使用的任务。如果你需要更改默认编译器，可以在命令面板中运行任务：配置默认构建任务。或者，你可以修改 tasks.json 文件，并通过替换以下片段来移除默认设置

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

替换为

    "group": "build",

修改 tasks.json

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

调试 helloworld.cpp

要调试代码，

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

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

    screenshot of breakpoint in helloworld.cpp

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

    Screenshot of play button drop-down

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

    Build and debug task

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

    Hello World Terminal Output

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

探索调试器

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

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

  • 编辑器在开始调试器之前突出显示你设置断点的行

    Initial breakpoint

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

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

    Debugging controls

单步调试代码

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

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

    Step over button

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

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

  3. 再次按逐过程以执行 cout 语句。

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

设置监视

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

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

    Watch window

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

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

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

    Mouse hover

使用 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++ 配置页面。

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 extensions”的构建错误，你的 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