将 GCC 与 MinGW 结合使用
在本教程中，你将配置 Visual Studio Code 以使用来自 mingw-w64 的 GCC C++ 编译器 (g++) 和 GDB 调试器来创建在 Windows 上运行的程序。配置 VS Code 后，你将编译、运行和调试一个 Hello World 程序。
本教程不教授 GCC、GDB、MinGW-w64 或 C++ 语言。对于这些主题，Web 上有许多优秀的资源可供参考。
如果你遇到任何问题，请随时在 VS Code 文档存储库中为此教程提出问题。
先决条件
要成功完成本教程，你必须执行以下步骤
-
安装 适用于 VS Code 的 C/C++ 扩展。你可以通过在“扩展”视图（⇧⌘X (Windows, Linux Ctrl+Shift+X)）中搜索“C++”来安装 C/C++ 扩展。
安装 MinGW-w64 工具链
通过 MSYS2 获取最新版本的 MinGW-w64，它提供 GCC、MinGW-w64 以及其他有用的 C++ 工具和库的最新原生版本。这将为你提供编译代码、调试代码以及配置代码以与 IntelliSense 配合使用的必要工具。
要安装 MinGW-w64 工具链，请查看此视频或按照以下步骤操作
-
你可以从 MSYS2 页面下载最新安装程序，或使用此直接安装程序链接。
-
运行安装程序并按照安装向导的步骤操作。请注意，MSYS2 需要 64 位 Windows 8.1 或更高版本。
-
在向导中，选择你所需的安装文件夹。记下此目录以供后续使用。在大多数情况下，推荐的目录是可接受的。当你设置“开始”菜单快捷方式时也同样适用。完成后，确保选中立即运行 MSYS2框，然后选择完成。这将为你打开一个 MSYS2 终端窗口。
-
在此终端中，通过运行以下命令安装 MinGW-w64 工具链
pacman -S --needed base-devel mingw-w64-ucrt-x86_64-toolchain -
通过按 Enter 键接受
toolchain组中包的默认数量。
-
当提示是否继续安装时，输入
Y。 -
使用以下步骤将 MinGW-w64
bin文件夹的路径添加到 WindowsPATH环境变量中- 在 Windows 搜索栏中，键入设置以打开 Windows 设置。
- 搜索编辑账户的环境变量。
- 在用户变量中，选择
Path变量，然后选择编辑。 - 选择新建，然后将你在安装过程中记录的 MinGW-w64 目标文件夹添加到列表中。如果你使用了上述默认设置，则路径为：
C:\msys64\ucrt64\bin。 - 选择确定，然后在环境变量窗口中再次选择确定以更新
PATH环境变量。你必须重新打开任何控制台窗口才能使更新后的PATH环境变量生效。
检查你的 MinGW 安装
要检查你的 MinGW-w64 工具是否正确安装并可用，请打开一个新命令提示符并键入
gcc --version
g++ --version
gdb --version
你应该会看到显示你已安装的 GCC、g++ 和 GDB 版本的输出。如果不是这种情况
- 确保你的 PATH 变量条目与安装工具链的 MinGW-w64 二进制文件位置匹配。如果编译器不存在于该 PATH 条目中，请确保你遵循了之前的说明。
- 如果
gcc输出正确，但gdb不正确，则需要从 MinGW-w64 工具集中安装你缺少的包。- 如果编译时收到“miDebuggerPath 值无效”消息，一个原因可能是你缺少
mingw-w64-gdb包。
- 如果编译时收到“miDebuggerPath 值无效”消息，一个原因可能是你缺少
创建 Hello World 应用
首先，让我们设置一个项目。
- 启动 Windows 命令提示符（在 Windows 搜索栏中输入Windows 命令提示符）。
- 运行以下命令。这些命令将创建一个名为
projects的空文件夹，你可以在其中放置所有 VS Code 项目。在那里，接下来的命令将创建并导航到名为helloworld的子文件夹。从那里，你将直接在 VS Code 中打开helloworld。
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。
添加 Hello World 源代码
现在粘贴此源代码
#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 将显示所需参数的信息。
如果 IntelliSense 尚未配置，请打开命令面板（⇧⌘P (Windows, Linux Ctrl+Shift+P)）并输入选择 IntelliSense 配置。从编译器下拉列表中，选择 Use gcc.exe 进行配置。有关更多信息，请参阅IntelliSense 配置文档。
运行 helloworld.cpp
请记住，C++ 扩展使用你机器上安装的 C++ 编译器来构建你的程序。在尝试在 VS Code 中运行和调试 helloworld.cpp 之前，请确保你已完成“安装 MinGW-w64 工具链”步骤。
-
打开
helloworld.cpp，使其成为活动文件。 -
单击编辑器右上角的播放按钮。
-
从系统上检测到的编译器列表中选择 C/C++: g++.exe 构建和调试活动文件。
你只会在第一次运行 helloworld.cpp 时被要求选择编译器。此编译器将设置为 tasks.json 文件中的“默认”编译器。
-
构建成功后，程序的输出将显示在集成的终端中。
恭喜！你刚刚在 VS Code 中运行了你的第一个 C++ 程序！
理解 tasks.json
当你第一次运行程序时，C++ 扩展会创建一个 tasks.json 文件，你将在项目的 .vscode 文件夹中找到它。 tasks.json 存储你的构建配置。
你的新 tasks.json 文件应类似于下面的 JSON
{
"tasks": [
{
"type": "cppbuild",
"label": "C/C++: g++.exe build active file",
"command": "C:\\msys64\\ucrt64\\bin\\g++.exe",
"args": [
"-fdiagnostics-color=always",
"-g",
"${file}",
"-o",
"${fileDirname}\\${fileBasenameNoExtension}.exe"
],
"options": {
"cwd": "${fileDirname}"
},
"problemMatcher": ["$gcc"],
"group": {
"kind": "build",
"isDefault": true
},
"detail": "Task generated by Debugger."
}
],
"version": "2.0.0"
}
注意：你可以在变量参考中了解有关
tasks.json变量的更多信息。
command 设置指定要运行的程序；在此情况下是 g++。
args 数组指定传递给 g++ 的命令行参数。这些参数在此文件中按照编译器预期的特定顺序进行列出。
此任务告诉 g++ 获取活动文件 (${file})，编译它，并在当前目录 (${fileDirname}) 中创建一个输出文件 (-o 开关)，该输出文件与活动文件同名但扩展名为 .exe (${fileBasenameNoExtension}.exe)。对于我们来说，这将生成 helloworld.exe。
label 值是你在任务列表中将看到的名称；你可以随意命名。
detail 值是你在任务列表中看到的任务描述。强烈建议重命名此值以将其与类似任务区分开来。
problemMatcher 值选择用于在编译器输出中查找错误和警告的输出解析器。对于 GCC，如果你使用 $gcc 问题匹配器，你将获得最佳结果。
从现在开始，播放按钮将从 tasks.json 中读取以确定如何构建和运行你的程序。你可以在 tasks.json 中定义多个构建任务，并且标记为默认的任务将由播放按钮使用。如果你需要更改默认编译器，可以在命令面板中运行任务：配置默认构建任务。或者，你可以修改 tasks.json 文件并删除默认值，方法是将此段落替换为
"group": {
"kind": "build",
"isDefault": true
},
替换为
"group": "build",
修改 tasks.json
从 2024 年 11 月 3 日起，MSYS2 默认禁用了 mingw-w64 的通配符支持。此更改会影响构建命令中如何处理 "*.cpp" 等通配符。要在 tasks.json 中构建多个 C++ 文件，你必须显式列出文件，使用 make 或 cmake 等构建系统，或实施以下变通方法：https://www.msys2.org/docs/c/#expanding-wildcard-arguments。
如果你以前使用 "${workspaceFolder}/*.cpp" 来编译当前文件夹中的所有 .cpp 文件，这将不再直接有效。相反，你可以手动列出文件或定义构建脚本。
调试 helloworld.cpp
要调试你的代码，
- 返回到
helloworld.cpp，使其成为活动文件。 - 通过单击编辑器边距或在当前行使用 F9 来设置断点。
- 从播放按钮旁边的下拉菜单中，选择调试 C/C++ 文件。
- 从系统上检测到的编译器列表中选择 C/C++: g++ 构建和调试活动文件（你只会在第一次运行或调试
helloworld.cpp时被要求选择编译器）。
播放按钮有两种模式：运行 C/C++ 文件和调试 C/C++ 文件。它将默认为上次使用的模式。如果你在播放按钮中看到调试图标，则只需选择播放按钮即可进行调试，而无需使用下拉菜单。
探索调试器
在你开始逐行调试代码之前，让我们花点时间注意一下用户界面中的一些变化
-
集成终端显示在源代码编辑器的底部。在调试控制台选项卡中，你将看到指示调试器已启动并运行的输出。
-
编辑器突出显示你在启动调试器之前设置断点的行
-
左侧的运行和调试视图显示调试信息。你将在本教程后面看到一个示例。
-
在代码编辑器的顶部，出现一个调试控制面板。你可以通过抓住左侧的点将其在屏幕上移动。
逐步执行代码
现在你已准备好开始逐步执行代码。
-
选择调试控制面板中的跳过图标。
这将把程序执行推进到 for 循环的第一行，并跳过在创建和初始化
msg变量时调用的vector和string类中的所有内部函数调用。注意左侧变量窗口中的变化。
在这种情况下，错误是预期内的，因为尽管循环的变量名称现在对调试器可见，但语句尚未执行，因此此时没有什么可读的。然而，
msg的内容是可见的，因为该语句已完成。 -
再次按跳过以进入此程序中的下一条语句（跳过所有用于初始化循环的内部代码）。现在，变量窗口显示有关循环变量的信息。
-
再次按跳过以执行
cout语句。（请注意，C++ 扩展在循环退出之前不会向调试控制台打印任何输出。） -
如果你愿意，可以继续按跳过，直到向量中的所有单词都已打印到控制台。但如果你好奇，请尝试按步进按钮以逐步执行 C++ 标准库中的源代码！
要返回到自己的代码，一种方法是不断按跳过。另一种方法是在代码中设置断点，方法是切换到代码编辑器中的
helloworld.cpp选项卡，将插入点放在循环内cout语句的某个位置，然后按 F9。一个红点出现在左侧的边槽中，表示该行已设置断点。
然后按 F5 从标准库头文件中的当前行开始执行。执行将在
cout处中断。如果你愿意，可以再次按 F9 以关闭断点。循环完成后，你可以在集成终端中看到输出，以及 GDB 输出的一些其他诊断信息。
设置监视
有时，你可能希望在程序执行时跟踪变量的值。你可以通过在变量上设置监视来做到这一点。
-
将插入点放在循环内。在监视窗口中，选择加号，然后在文本框中键入
word，它是循环变量的名称。现在，在你逐步执行循环时查看监视窗口。
-
在循环之前添加此语句：
int i = 0;，然后添加另一个监视。接着，在循环内部，添加此语句：++i;。现在按照上一步的方式添加一个i的监视。 -
要快速查看任何变量的值，当执行在断点处暂停时，你可以将鼠标指针悬停在其上。
使用 launch.json 自定义调试
当你使用播放按钮或 F5 进行调试时，C++ 扩展会动态创建一个调试配置。
在某些情况下，你可能希望自定义调试配置，例如指定要在运行时传递给程序的参数。你可以在 launch.json 文件中定义自定义调试配置。
要创建 launch.json，请从播放按钮下拉菜单中选择添加调试配置。
然后，你将看到各种预定义调试配置的下拉列表。选择 C/C++: g++.exe 构建和调试活动文件。
VS Code 在 .vscode 文件夹中创建了一个 launch.json 文件，它看起来像这样
{
"configurations": [
{
"name": "C/C++: g++.exe build and debug active file",
"type": "cppdbg",
"request": "launch",
"program": "${fileDirname}\\${fileBasenameNoExtension}.exe",
"args": [],
"stopAtEntry": false,
"cwd": "${fileDirname}",
"environment": [],
"externalConsole": false,
"MIMode": "gdb",
"miDebuggerPath": "C:\\msys64\\ucrt64\\bin\\gdb.exe",
"setupCommands": [
{
"description": "Enable pretty-printing for gdb",
"text": "-enable-pretty-printing",
"ignoreFailures": true
},
{
"description": "Set Disassembly Flavor to Intel",
"text": "-gdb-set disassembly-flavor intel",
"ignoreFailures": true
}
],
"preLaunchTask": "C/C++: g++.exe build active file"
}
],
"version": "2.0.0"
}
在上面的 JSON 中，program 指定了你要调试的程序。这里它设置为活动文件文件夹 (${fileDirname}) 和带有 .exe 扩展名的活动文件名 (${fileBasenameNoExtension}.exe)，如果 helloworld.cpp 是活动文件，则将是 helloworld.exe。 args 属性是一个数组，用于在运行时传递给程序的参数。
默认情况下，C++ 扩展不会向你的源代码添加任何断点，并且 stopAtEntry 值设置为 false。
将 stopAtEntry 值更改为 true，以使调试器在开始调试时在 main 方法处停止。
从现在开始，播放按钮和 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++ 配置页面。当你在此处进行更改时，VS Code 会将它们写入 .vscode 文件夹中名为 c_cpp_properties.json 的文件。
在这里，我们已将配置名称更改为GCC，将编译器路径下拉菜单设置为 g++ 编译器，并将智能感知模式设置为与编译器匹配（gcc-x64）。
Visual Studio Code 将这些设置放在 .vscode\c_cpp_properties.json 中。如果你直接打开该文件，它应该看起来像这样
{
"configurations": [
{
"name": "GCC",
"includePath": ["${workspaceFolder}/**"],
"defines": ["_DEBUG", "UNICODE", "_UNICODE"],
"windowsSdkVersion": "10.0.22000.0",
"compilerPath": "C:/msys64/mingw64/bin/g++.exe",
"cStandard": "c17",
"cppStandard": "c++17",
"intelliSenseMode": "windows-gcc-x64"
}
],
"version": 4
}
只有当你的程序包含不在工作区或标准库路径中的头文件时，才需要添加到包含路径数组设置。强烈建议不要将系统包含路径添加到我们支持的编译器的 includePath 设置中。
编译器路径
该扩展使用 compilerPath 设置来推断 C++ 标准库头文件的路径。当该扩展知道在哪里可以找到这些文件时，它可以提供智能补全和转到定义导航等功能。
C/C++ 扩展会尝试使用其在系统上找到的默认编译器填充 compilerPath。该扩展会在几个常见的编译器位置进行查找，但只会自动选择位于“Program Files”文件夹之一或其路径列在 PATH 环境变量中的编译器。如果能找到 Microsoft Visual C++ 编译器，则会选择它；否则，它将选择一个版本的 gcc、g++ 或 clang。
如果你安装了不止一个编译器，你可能需要更改 compilerPath 以匹配你的项目首选编译器。你也可以使用命令面板中的C/C++：选择 IntelliSense 配置...命令来选择扩展检测到的编译器之一。
故障排除
MSYS2 已安装，但仍找不到 g++ 和 gdb
你必须按照 MSYS2 网站上的步骤，使用 MSYS CLI 安装完整的 MinGW-w64 工具链 (pacman -S --needed base-devel mingw-w64-ucrt-x86_64-toolchain) 以及所有必需的先决条件。该工具链包括 g++ 和 gdb。
作为 Windows 用户，运行 pacman 命令时出现错误
Windows 计算机上的 UCRT 仅包含在 Windows 10 或更高版本中。如果你使用的是其他版本的 Windows，请运行以下不使用 UCRT 的命令
pacman -S --needed base-devel mingw-w64-x86_64-toolchain
将 MinGW-w64 目标文件夹添加到环境变量列表时，默认路径将是：C:\msys64\mingw64\bin。
MinGW 32 位
如果你需要 MinGW 工具集的 32 位版本，请查阅 MSYS2 wiki 上的下载部分。它包含 32 位和 64 位安装选项的链接。
后续步骤
- 探索 VS Code 用户指南。
- 回顾 C++ 扩展概述。
- 创建一个新工作区，将你的
.vscodeJSON 文件复制到其中，调整新工作区路径、程序名称等所需设置，然后开始编码！