在 Visual Studio Code 中使用 Clang
在本教程中，你将在 macOS 上配置 Visual Studio Code 以使用 Clang/LLVM 编译器和调试器。
配置 VS Code 后，你将在 VS Code 中编译和调试 C++ 程序。本教程不教授 Clang 或 C++ 语言。对于这些主题，Web 上有许多优秀的资源可用。
如果遇到任何问题，请随时在 VS 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））
你还可以通过选择文件 > 自动保存来启用自动保存，从而自动保存文件更改。你可以在 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。
-
打开
helloworld.cpp，使其成为活动文件。 -
单击编辑器右上角的播放按钮。
-
从系统上检测到的编译器列表中选择 C/C++: clang++ 生成和调试活动文件。
只有在首次运行 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
你可以通过使用类似于 "${workspaceFolder}/*.cpp" 的参数而不是 "${file}" 来修改 tasks.json 以构建多个 C++ 文件。这会构建当前文件夹中的所有 .cpp 文件。你还可以通过将 "${fileDirname}/${fileBasenameNoExtension}" 替换为硬编码文件名（例如 "${workspaceFolder}/myProgram.out"）来修改输出文件名。
调试 helloworld.cpp
要调试你的代码，
-
回到
helloworld.cpp，使其成为活动文件。 -
通过单击编辑器边距或在当前行上使用 F9 设置断点。
-
从播放按钮旁边的下拉菜单中，选择调试 C/C++ 文件。
-
从系统上检测到的编译器列表中选择 C/C++: clang++ 生成和调试活动文件（你只会在首次运行或调试
helloworld.cpp时被要求选择编译器）。 -
你将看到任务执行并将输出打印到终端窗口。
播放按钮有两种模式：运行 C/C++ 文件和调试 C/C++ 文件。默认是上次使用的模式。如果你在播放按钮中看到调试图标，则可以直接选择播放按钮进行调试，而无需选择下拉菜单项。
探索调试器
在开始单步执行代码之前，让我们花点时间注意用户界面中的几处更改
-
集成终端出现在源代码编辑器的底部。在调试控制台选项卡中，你将看到指示调试器已启动并正在运行的输出。
-
编辑器会突出显示你在启动调试器之前设置断点的行
-
活动栏中的运行和调试视图显示调试信息。
-
在代码编辑器的顶部，会出现一个调试控制面板。你可以通过拖动左侧的点来在屏幕上移动它。
单步执行代码
现在你已准备好开始单步执行代码。
-
在调试控制面板中选择跳过图标，以便突出显示
for (const string& word : msg)语句。
跳过命令会跳过在创建和初始化
msg变量时调用的vector和string类中的所有内部函数调用。注意变量窗口中的变化。msg的内容可见，因为该语句已完成。 -
再次按跳过以前进到下一条语句（跳过为初始化循环而执行的所有内部代码）。现在，变量窗口显示有关循环变量的信息。
-
再次按跳过以执行
cout语句。 -
如果你愿意，可以继续按跳过，直到向量中的所有单词都打印到控制台。但是如果你好奇，请尝试按步入按钮以单步执行 C++ 标准库中的源代码！
设置监视
你可能希望在程序执行时跟踪变量的值。你可以通过在变量上设置监视来完成此操作。
-
在监视窗口中，选择加号并在文本框中输入
word。这是循环变量的名称。现在，在你单步执行循环时查看监视窗口。
注意：监视变量的值仅在程序执行在变量范围内时可用。例如，对于循环变量，该值仅在程序执行循环时可用。
-
通过在循环之前添加此语句：
int i = 0;来添加另一个监视。然后，在循环内部，添加此语句：++i;。现在，像上一步一样为i添加一个监视。 -
在执行暂停时，你可以将鼠标指针悬停在任何变量上，以快速查看其值。
使用 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++ 扩展进行更多控制，请创建一个 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/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 文件复制到其中，调整新工作区路径、程序名称等所需设置，然后开始编码！