配置 Microsoft C++ 的 VS Code

在这个教程中，你将配置Visual Studio Code以便在Windows上使用Microsoft Visual C++编译器和调试器。

配置 VS Code 后，你将用 VS Code 编译并调试一个简单的 Hello World 程序。本教程不教授Microsoft C++工具集或C++语言的详细信息。对于这些主题，网上有许多优质资源。

如果你有任何问题，欢迎在VS Code文档库中提交本教程的问题。

前提条件

要成功完成本教程，你需要完成以下作：

  1. 安装Visual Studio Code。

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

    C/C++ 扩展

  3. 安装 Microsoft Visual C++（MSVC）编译工具组。

    如果你有最新版本的 Visual Studio，可以从 Windows 开始菜单打开 Visual Studio 安装程序，确认 C++ 工作负载已被检查。如果还没安装，那就勾选这个框，然后在安装程序里选择修改按钮。

    你也可以用C++工作安装桌面开发，无需完整安装Visual Studio IDE。从Visual Studio下载页面向下滚动，直到你在“所有下载”部分看到“Visual Studio工具”，然后选择“Visual Studio 2022构建工具”下载。

    Visual Studio 构建工具下载

    这会启动Visual Studio安装程序，弹出一个对话框，显示可用的Visual Studio构建工具工作负载。查看桌面开发中的C++工作负载，选择安装。

    CPP 构建工具的工作量

注意：只要你拥有有效的Visual Studio许可证（社区版、专业版或企业版），你可以使用Visual Studio构建工具集中的C++工具集和Visual Studio Code来开发、构建和测试任何C++代码。

检查你的 Microsoft Visual C++ 安装

要通过命令行或VS Code使用MSVC，必须在Visual Studio的开发者命令提示符中运行。普通的shell，比如PowerShell、Bash或Windows命令提示符，并未设置必要的路径环境变量。

要打开VS的开发者命令提示符，在Windows开始菜单输入“developer”，你应该会看到它出现在建议列表中。具体名称取决于你安装的Visual Studio版本或Visual Studio构建工具。选择该项目以打开提示。

开发者命令提示符

你可以测试你是否拥有C++编译器，cl.exe，正确安装后输入“cl”，你应该会看到带有版本和基本使用描述的版权信息。

检查安装cl.exe

如果开发者命令提示符用 BuildTools 位置作为起始目录（你不想把项目放在那里），请导航到你的用户文件夹（C：\users\{你的用户名}\）然后才开始创建新项目。

注意：如果你无法在开发者命令提示符中运行 VS Code，你可以在“运行 VS Code”中找到一个替代方案，帮助你在开发者命令提示符之外用 VS Code 构建 C++ 项目。

创建Hello World

在开发者命令提示符里，创建一个叫“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设置）

添加源代码文件

在文件资源管理器标题栏中，选择“新建文件”按钮并命名文件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

在你的新helloworld.cpp档案，悬停在上向量或弦查看类型信息。在味精变量，开始输入MSG。就像调用成员函数时那样。你应该会立刻看到一个完备列表，显示所有成员函数，以及一个窗口显示味精主题：

语句补全 IntelliSense

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

快跑，helloworld.cpp

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

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

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

    helloworld.cpp播放按钮截图

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

    C++调试配置下拉菜单

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

  1. 构建成功后，程序的输出会显示在集成的终端中。

    程序输出截图

如果你在尝试用 cl.exe 构建和调试时出现错误，请确保你已经通过 Visual Studio 的开发者命令提示符启动了 VS Code，并且代码。快捷键。

尝试使用MSVC而不运行VS代码时，VS的开发者命令提示符出现错误通知

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

你的新tasks.json文件应与下面的 JSON 类似：

{
  "version": "2.0.0",
  "tasks": [
    {
      "type": "shell",
      "label": "C/C++: cl.exe build active file",
      "command": "cl.exe",
      "args": [
        "/Zi",
        "/EHsc",
        "/Fe:",
        "${fileDirname}\\${fileBasenameNoExtension}.exe",
        "${file}"
      ],
      "problemMatcher": ["$msCompile"],
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "detail": "Task generated by Debugger."
    }
  ]
}

注意：你可以了解更多tasks.json变量引用中的变量。

该指挥设置指定要运行的程序;在这种情况下，这就是“cl.exe”。该argsarray 指定将传递给 cl.exe 的命令行参数。这些参数必须按照编译器预期的顺序指定。

该任务告诉 C++ 编译器获取活动文件（${file}编译，并创建可执行文件（/Fe：当前目录中的开关（${fileDirname}） 与活动文件同名，但.exe扩展（${fileBasenameNoExtension}.exe），结果为helloworld.exe举个例子。

该唱片公司价值是你在任务列表中看到的;你可以随意命名。

该细节价值是你在任务列表中描述任务的部分。强烈建议重新命名该数值，以区别于类似任务。

该problemMatcherValue 选择输出解析器用于在编译器输出中查找错误和警告。cl.exe方面，使用以下条件会获得最佳效果$msCompile问题匹配器。

从现在起，播放按钮将从以下内容读取tasks.json想办法构建和运行你的程序。你可以在tasks.json，标记为默认的任务将由播放按钮使用。如果你需要更改默认编译器，可以运行任务：配置默认构建任务。或者你也可以修改tasks.json文件并通过替换该段来移除默认数据：

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

附带这个：

    "group": "build",

修改tasks.json

你可以修改你的tasks.json通过使用以下参数构建多个C++文件“${workspaceFolder}/*.cpp”代替“${file}”.这将建立所有.cpp文件放在你当前的文件夹里。你也可以通过替换输出文件名来修改“${fileDirname}\\${fileBasenameNoExtension}.exe”带有硬编码文件名（例如）“${workspaceFolder}\\myProgram.exe”).

调试helloworld.cpp

要调试你的代码，

  1. 回到helloworld.cpp所以它是活跃文件。
  2. 通过点击编辑器边距或当前行的F9设置断点。《断点》截图 helloworld.cpp
  3. 在播放按钮旁的下拉菜单中，选择“调试 C/C++ 文件”。播放按钮下拉菜单截图
  4. 选择 C/C++：cl.exe系统检测到的编译器列表中构建并调试当前文件（只有在第一次运行或调试时才会被要求选择编译器helloworld.cpp).C++调试配置下拉菜单

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

如果你在尝试用 cl.exe 构建和调试时出现错误，请确保你已经通过 Visual Studio 的开发者命令提示符启动了 VS Code，并且代码。快捷键。

尝试使用MSVC而不运行VS代码时，VS的开发者命令提示符出现错误通知

探索调试器

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

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

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

    初始断点

  • 左侧的运行和调试视图显示调试信息。你将在教程后面看到示例。

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

    调试控制

逐一了解代码

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

  1. 点击或点击调试控制面板中的“Step Over”图标。

    踩踏按钮

    这将将程序执行推进到for循环的第一行，跳过所有内部函数调用向量以及弦当味精变量已被创建并初始化。注意左侧变量窗口的变化。

    调试窗口

    在这种情况下，错误是预期的，因为虽然循环的变量名现在已被调试器看到，但该语句尚未执行，因此此时没有可读的内容。目录味精不过，这些都显现出来，因为该陈述已经完成。

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

  3. 再次按“Step”键执行考特陈述。（注意，C++ 扩展在循环结束前不会向调试控制台输出任何输出。）

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

    GCC标准库头部中的断点

    回到你自己的代码，一种方法是一直按“Step over”。另一种方法是通过切换到helloworld.cpp在代码编辑器中，插入点放置在考特循环内的语句，并按下F9。左侧排水沟中会出现红点，表示该直线被设置了断点。

    主打断点

    然后按 F5 从标准库头部当前行开始执行。执行将继续考特.如果你愿意，可以再按一次F9来关闭断点。

定个手表

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

  1. 将插入点放置在环内。在“手表”窗口中，选择加号，在文本框中输入字，即循环变量的名称。现在，随着你穿过循环，查看“手表”窗口。

    手表窗口

  2. 在循环前添加以下陈述，再加一个手表：智 i = 0;.然后，在循环内添加以下陈述：++i;.现在添加一个手表i就像你上一步做的那样。

  3. 要在断点暂停执行时快速查看任意变量的值，可以用鼠标指针悬停在断点上。

    鼠标悬停

用launch.json自定义调试

当你用播放键或F5调试时，C++扩展会动态生成调试配置。

有些情况下你需要自定义调试配置，比如指定运行时要传递给程序的参数。你可以在launch.json档案。

创造launch.json， 从播放按钮下拉菜单中选择添加调试配置。

添加调试配置播放按钮菜单

然后你会看到一个下拉菜单，显示各种预定义的调试配置。选择 C/C++：cl.exe构建并调试活动文件。

C++调试配置下拉菜单

VS Code 创建了launch.json文件，看起来大致如下：

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "C/C++: cl.exe build and debug active file",
      "type": "cppvsdbg",
      "request": "launch",
      "program": "${fileDirname}\\${fileBasenameNoExtension}.exe",
      "args": [],
      "stopAtEntry": false,
      "cwd": "${workspaceFolder}",
      "environment": [],
      "externalConsole": false,
      "preLaunchTask": "C/C++: cl.exe build active file"
    }
  ]
}

在上述JSON中，节目指定你想调试的程序。这里设置为当前文件文件夹（${fileDirname}）以及带有.exe扩展（${fileBasenameNoExtension}.exe），如果helloworld.cpp是活跃文件，将为helloworld.exe.该args属性是运行时传递给程序的参数数组。

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

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

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

C/C++ 配置

如果你想对 C/C++ 扩展有更多控制，可以创建一个c_cpp_properties.json文件允许你更改设置，比如编译器路径、路径、C++标准（默认为C++17）等。

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

命令调色板

这会打开 C/C++ 配置页面。当你在这里做更改时，VS Code 会把它们写入一个叫做c_cpp_properties.json在.vscode文件夹。

命令调色板

Visual Studio Code 将这些设置置于.vscode\c_cpp_properties.json.如果你直接打开那个文件，应该会看到这样的样子：

{
  "configurations": [
    {
      "name": "Win32",
      "includePath": ["${workspaceFolder}/**"],
      "defines": ["_DEBUG", "UNICODE", "_UNICODE"],
      "windowsSdkVersion": "10.0.18362.0",
      "compilerPath": "C:/Program Files (x86)/Microsoft Visual Studio/2019/BuildTools/VC/Tools/MSVC/14.24.28314/bin/Hostx64/x64/cl.exe",
      "cStandard": "c11",
      "cppStandard": "c++17",
      "intelliSenseMode": "msvc-x64"
    }
  ],
  "version": 4
}

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

编译器路径

该编译路径设置是你配置中一个重要的设置。扩展名利用它推断出 C++ 标准库头文件的路径。当扩展知道这些文件的位置时，它可以提供智能完成和“进入定义”导航等实用功能。

C/C++ 扩展尝试填充编译路径默认编译器位置基于它在你系统上找到的信号。该扩展在多个常见的编译器位置进行查找。

该编译路径搜索顺序如下：

  • 首先检查 Microsoft Visual C++ 编译器 Ope
  • 然后在 Windows Subsystem for Linux （WSL） 上找 g++
  • 然后是 Mingw-w64 的 g++。

如果你安装的是 g++ 或 WSL，可能需要更换编译路径以匹配你项目中首选的编译器。对于Microsoft C++，路径应该是这样，取决于你安装的具体版本：“C：/Program Files （x86）/Microsoft Visual Studio/2017/BuildTools/VC/Tools/MSVC/14.16.27023/bin/Hostx64/x64/cl.exe”。

重用你的C++配置

VS Code 现已配置为使用 Microsoft C++ 编译器。配置适用于当前工作区。要重用配置，只需将JSON文件复制到一个.vscode在新的项目文件夹（工作区）中加入文件夹，并根据需要更改源文件和可执行文件的名称。

在开发者命令提示符之外运行VS Code。

在某些情况下，无法在Visual Studio的开发者命令提示符中运行VS代码（例如，在远程开发中通过SSH场景）。在这种情况下，你可以在构建过程中自动初始化Visual Studio的开发者命令提示符，使用以下方法。tasks.json配置：

{
  "version": "2.0.0",
  "windows": {
    "options": {
      "shell": {
        "executable": "cmd.exe",
        "args": [
          "/C",
          // The path to VsDevCmd.bat depends on the version of Visual Studio you have installed.
          "\"C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/Common7/Tools/VsDevCmd.bat\"",
          "&&"
        ]
      }
    }
  },
  "tasks": [
    {
      "type": "shell",
      "label": "cl.exe build active file",
      "command": "cl.exe",
      "args": [
        "/Zi",
        "/EHsc",
        "/Fe:",
        "${fileDirname}\\${fileBasenameNoExtension}.exe",
        "${file}"
      ],
      "problemMatcher": ["$msCompile"],
      "group": {
        "kind": "build",
        "isDefault": true
      }
    }
  ]
}

注：通往VsDevCmd.bat根据Visual Studio版本或安装路径，可能会有所不同。你可以找到通往VsDevCmd.bat通过打开命令提示符并运行dir “\VsDevCmd*” /s.

故障排除

“cl.exe”一词未被认可

如果你看到错误：“'cl.exe' 一词未被识别为 cmdlet、函数、脚本文件或可作程序的名称”，通常意味着你正在运行 VS Code，而不是在 Visual Studio 的开发者命令提示符中运行，而 VS Code 不知道cl.exe编译器。

VS Code 必须从开发者命令提示符启动 Visual Studio 执行，或者任务必须配置为在开发者命令提示符之外运行。

你总可以通过打开一个新终端（⌃⇧'（Windows，Linux Ctrl+Shift+'））并输入“cl”来验证，确认你在开发者命令提示符上下文中运行 VS Code。cl.exeVS Code可访问。

致命错误 C1034：assert.h：无包含路径设置

在这种情况下，cl.exeVS Code 可以通过路径但 VS Code 仍需从开发者命令提示符启动 Visual Studio 的命令提示符，或配置为在开发者命令提示符之外运行。否则，cl.exe无法访问重要的环境变量，如包括.

下一步

  • 请查看VS Code用户指南。
  • 请查看C++扩展概述。
  • 创建一个新工作区，复制你的工作区.vscode给它做JSON文件，调整新工作区路径、程序名称等的必要设置，然后开始写代码！