在Visual Studio Code中使用Clang

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

配置 VS Code 后，你将用 VS Code 编译和调试一个 C++ 程序。本教程不会教你关于Clang或C++语言的内容。对于这些主题，网上有许多优质资源。

如果你遇到任何困难，欢迎在VS Code文档库提交本教程的问题。

前提条件

要成功完成本教程，你必须完成以下步骤：

  1. 在macOS上安装Visual Studio Code。

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

    C/C++ 扩展

确保Clang安装

Clang可能已经安装在你的Mac上了。要验证是否正确，请打开macOS终端窗口并输入以下命令：

clang --version

如果没有安装 Clang，请输入以下命令安装包括 Clang 在内的命令行开发工具：

xcode-select --install

创建Hello World应用

在macOS终端里，创建一个名为项目你可以在这里存储所有VS Code项目，然后创建一个名为HelloWorld进入该文件夹，通过终端窗口输入以下命令打开 VS Code：

mkdir projects
cd projects
mkdir helloworld
cd helloworld
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的实际作，请将鼠标悬停向量或弦查看它们的类型信息。如果你打字MSG。在第10行，你可以看到一个由IntelliSense生成的推荐成员函数的补全列表：

语句补全 IntelliSense

你可以按Tab键插入选中的成员。然后，当你加上开头括号时，会显示函数所需的参数信息。

如果 IntelliSense 尚未配置，打开命令面板（⇧⌘P（Windows，Linux Ctrl+Shift+P）），进入选择 IntelliSense 配置。从编译器下拉菜单中选择使用clang++去配置。更多信息可见 IntelliSense 配置文档。

快跑，helloworld.cpp

记住，C++扩展是用你机器上安装的C++编译器来构建程序的。在尝试运行和调试之前，确保你安装了C++编译器，比如Clanghelloworld.cpp在VS Code中。

  1. 开门helloworld.cpp所以它是活跃文件。

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

    helloworld.cpp播放按钮截图

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

    构建与调试任务

你只有在第一次运行时才会被要求选择编译器helloworld.cpp.该编译器是设置在tasks.json档案。

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

    程序输出截图

恭喜你！你刚刚在VS Code中运行了你的第一个C++程序！

理解tasks.json

第一次运行程序时，C++扩展会创建tasks.json，位于你项目的.vscode文件夹。tasks.json存储器构建配置。

这里有一个示例tasks.jsonmacOS上的文件：

{
  "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变量引用中的变量。

该指挥设置指定要运行的程序。在这种情况下，也就是说叮当++.

该argsarray 指定传递给 clang++ 的命令行参数。这些参数必须按照编译器预期的顺序指定。

该任务告诉 C++ 编译器获取活动文件（${file}编译，并生成输出文件（-哦当前目录中的开关（${fileDirname}）与活跃文件同名但没有文件扩展名（${fileBasenameNoExtension}).这个过程会HelloWorld.

该唱片公司价值是你在任务列表中看到的，这取决于你的个人偏好。

该细节value 是任务列表中任务的描述。更新这个字符串以区别于类似任务。

该problemMatcherValue 选择输出解析器用于在编译器输出中查找错误和警告。对于 clang++，其中$gcc问题匹配器能带来最佳结果。

从现在开始，播放按钮总是读取tasks.json想办法构建和运行你的程序。你可以在tasks.json，标记为默认的任务就是播放按钮使用的任务。如果你需要更改默认编译器，可以在命令面板中运行“任务：配置默认构建任务”。或者你也可以修改tasks.json文件并通过替换该段来移除默认数据：

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

附带这个：

    "group": "build",

修改tasks.json

你可以修改你的tasks.json通过使用以下参数构建多个C++文件“${workspaceFolder}/*.cpp”代替“${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. 你会看到任务执行，并打印输出到终端窗口。

    Hello World 终端输出

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

探索调试器

在你开始逐步浏览代码之前，让我们花点时间注意用户界面的几处变化：

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

  • 编辑器会在启动调试器前高亮设置断点的那一行：

    初始断点

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

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

    调试控制

逐一了解代码

现在你准备好开始逐步解析代码了。

  1. 在调试控制面板中选择“Step over”图标，使得对于（const string ： word： MSG）声明被高亮显示。

    踩踏按钮

    Step Over 命令跳过了向量以及弦当味精变量被创建并初始化。注意变量窗口的变化。目录味精是因为该语句已经完成。

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

  3. 再次按“Step”键执行考特陈述。

  4. 如果你愿意，可以一直按“跨步”，直到向量中的所有单词都打印到控制台上。但如果你感兴趣，可以试试按“Step In”按钮，在C++标准库里逐步浏览源代码！

定个手表

你可能需要在程序执行时跟踪变量的值。你可以通过在变量上设置一个手表来实现。

  1. 在手表窗口中，选择加号并输入字在文本框中。这就是循环变量的名称。现在，随着你穿过循环，查看“手表”窗口。

    手表窗口

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

  2. 在循环前添加以下陈述，再加一个手表：智 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"
}

该节目设置指定你想调试的程序。这里设置为当前文件文件夹${fileDirname}以及活跃文件名${fileBasenameNoExtension}，如果helloworld.cpp是活跃文件，将为HelloWorld.该args属性是运行时传递给程序的参数数组。

默认情况下，C++扩展不会为你的源代码添加任何断点，且stopAtEntry（入口停止）值设为错误.

更改stopAtEntry（入口停止）值为确实如此以使调试器在主要角色当你开始调试时。

确保预启动任务值与唱片公司构建任务的tasks.json档案。

从现在开始，播放键和F5会从你的位置读取launch.json启动程序调试时的文件。

添加额外的 C/C++ 设置

为了更好地控制 C/C++ 扩展，可以创建一个c_cpp_properties.json文件允许你更改设置，比如编译器的路径，包括路径、编译的C++标准（如C++17）等。

通过命令面板中运行命令 C/C++： 编辑配置（UI）（⇧⌘P（Windows，Linux Ctrl+Shift+P））来查看 C/C++ 配置界面。

命令调色板

这会打开 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
}

只有当你的程序包含不在工作区或标准库路径中的头文件时，你才需要修改包含路径设置。

编译器路径

该扩展使用编译路径设置以推断出 C++ 标准库头文件的路径。当扩展知道在哪里找到这些文件时，它可以提供智能完成和“前往定义”导航等功能。

C/C++ 扩展尝试填充编译路径默认编译器位置基于它在你系统上找到的信号。该编译路径搜索顺序如下：

  • 你的PATH是已知编译器的名称。编译器在列表中的出现顺序取决于你的PATH。
  • 然后搜索硬编码的Xcode路径，例如：/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/

更多信息请参见IntelliSense配置文档。

Mac 框架路径

在 C/C++ 配置界面，向下滚动并展开高级设置，确保 Mac 框架路径指向系统头文件。例如：/Library/Developer/CommandLineTools/SDK/MacOSX.sdk/System/Library/Frameworks

故障排除

编译器和链接错误

最常见的错误原因（例如未定义_main，或者尝试与为未知且不支持的文件格式创建的文件进行链接，等等）发生在helloworld.cpp在你开始构建或调试时，它并不是当前的激活文件。这是因为编译器试图编译的不是源代码的东西，比如你的launch.json,tasks.json，或者c_cpp_properties.json档案。

如果你看到写作错误提到“C++11扩展”，说明你可能还没更新你的tasks.jsonbuild 任务以使用 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文件，调整新工作区路径、程序名称等的必要设置，然后开始编程！