在 Visual Studio Code 中使用 Clang
在本教程中,你将在 macOS 上配置 Visual Studio Code 以使用 Clang/LLVM 编译器和调试器。
配置完 VS Code 后,你将在 VS Code 中编译和调试 C++ 程序。本教程不教授有关 Clang 或 C++ 语言的知识。关于这些主题,网络上有许多优秀的资源。
如果遇到任何问题,请随时在 VS Code 文档仓库中为本教程提交 Issue。
前提条件
要成功完成本教程,你必须执行以下步骤
-
安装 VS Code 的 C++ 扩展。你可以通过在扩展视图中搜索“C++”来安装 C/C++ 扩展(⇧⌘X(Windows、Linux 为 Ctrl+Shift+X))。

确保已安装 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++ 扩展的关于 Insiders 版本可用性的通知,该版本可让你测试新功能和修复。你可以通过选择
X(清除通知)来忽略此通知。
探索 IntelliSense
IntelliSense 是一项通过添加代码补全、参数信息、快速信息和成员列表等代码编辑功能来帮助你更快、更高效地编写代码的工具。
要查看 IntelliSense 的实际效果,请将鼠标悬停在 vector 或 string 上以查看其类型信息。如果在第 10 行键入 msg.,你会看到一个由 IntelliSense 生成的推荐调用的成员函数补全列表

你可以按 Tab 键插入所选的成员。然后,当你添加左括号时,将显示有关该函数所需参数的信息。
如果尚未配置 IntelliSense,请打开命令面板(⇧⌘P(Windows、Linux 为 Ctrl+Shift+P))并输入 Select IntelliSense Configuration。从编译器下拉列表中选择 Use clang++ 进行配置。有关更多信息,请参阅 IntelliSense 配置文档。
运行 helloworld.cpp
请记住,C++ 扩展使用你在计算机上安装的 C++ 编译器来生成程序。在尝试在 VS Code 中运行和调试 helloworld.cpp 之前,请确保已安装 C++ 编译器(例如 Clang)。
-
打开
helloworld.cpp使其成为活动文件。 -
按编辑器右上角的运行按钮。

-
从系统检测到的编译器列表中选择 C/C++: clang++ build and debug active file。

系统仅在首次运行 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: Configure Default Build Task。或者,你可以修改 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 来设置断点。

-
从运行按钮旁边的下拉菜单中,选择 Debug C/C++ File。

-
从系统检测到的编译器列表中选择 C/C++: clang++ build and debug active file(系统仅在首次运行或调试
helloworld.cpp时要求你选择编译器)。
-
你将看到任务执行并将输出打印到终端窗口。

运行按钮有两种模式:Run C/C++ File 和 Debug C/C++ File。默认情况下为最后使用的模式。如果运行按钮中显示了调试图标,你可以直接选择运行按钮进行调试,而不必选择下拉菜单项。
探索调试器
在开始单步调试代码之前,让我们花点时间注意用户界面中的几个变化
-
集成终端出现在源代码编辑器的底部。在调试控制台选项卡中,你会看到指示调试器已启动并正在运行的输出。
-
编辑器会在启动调试器之前高亮显示你设置断点的行

-
活动栏中的运行和调试视图显示调试信息。
-
代码编辑器顶部会出现一个调试控制面板。你可以通过按住左侧的圆点在屏幕上拖动它。

单步调试代码
现在你可以开始单步调试代码了。
-
在调试控制面板中选择单步跳过图标,使
for (const string& word : msg)语句高亮显示。
单步跳过命令会跳过创建和初始化
msg变量时调用的vector和string类中的所有内部函数调用。注意Variables窗口中的变化。由于该语句已执行完成,因此可以看到msg的内容。 -
再次按单步跳过以转到下一条语句(跳过用于初始化循环的所有内部执行代码)。现在,Variables 窗口显示有关循环变量的信息。
-
再次按单步跳过以执行
cout语句。 -
如果你愿意,可以继续按单步跳过,直到向量中的所有单词都打印到控制台。但如果你好奇,可以尝试按单步进入按钮来单步执行 C++ 标准库中的源代码!
设置监视
你可能希望在程序执行时跟踪变量的值。你可以通过对该变量设置监视来做到这一点。
-
在监视窗口中,选择加号并在文本框中输入
word。这是循环变量的名称。现在,在单步调试循环时查看监视窗口。
注意:监视变量的值仅在程序执行处于该变量的作用域内时才可用。例如,对于循环变量,该值仅在程序执行循环时可用。
-
在循环前添加以下语句来添加另一个监视:
int i = 0;。然后,在循环内部添加以下语句:++i;。现在像在上一步中那样为i添加监视。 -
当执行暂停时,你可以将鼠标指针悬停在任何变量上以快速查看其值。

使用 launch.json 自定义调试
当你使用播放按钮或 F5 进行调试时,C++ 扩展会即时创建一个动态调试配置。
有时你可能需要自定义调试配置,例如指定在运行时传递给程序的参数。你可以在 launch.json 文件中定义自定义调试配置。
要创建 launch.json,请从运行按钮下拉菜单中选择 Add Debug Configuration。

随后你将看到用于各种预定义调试配置的下拉列表。选择 C/C++: clang++ build and debug active file。 
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++: Edit Configurations (UI) 命令来查看 C/C++ 配置 UI。

这将打开 C/C++ Configurations 页面。

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 指向系统头文件。例如:/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 中使用的初始化。请确保使用 Run 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": []
}
你可以使用 Terminal > Run Task... 并选择 Open Terminal 来运行此特定任务。
接受权限请求后,外部控制台应在调试时出现。
下一步计划
- 探索 VS Code 用户指南。
- 查看 C++ 扩展概述
- 创建一个新工作区,将你的 .json 文件复制到其中,针对新工作区路径、程序名称等调整必要的设置,然后开始编码!