配置 C/C++ IntelliSense
本文介绍如何配置 C/C++ 扩展,以便在 Visual Studio Code 中提供 C++ 特定的 IntelliSense 建议。IntelliSense 是 VS Code 中内置的一个有用的工具,它提供了各种代码编辑功能,可帮助您更快、更高效地进行编码。例如,代码自动补全、参数信息、语法高亮显示、代码操作(小灯泡)和成员列表都是使用 IntelliSense 生成的。
C/C++ IntelliSense 只要求您的系统上安装了 C/C++ 编译器。C/C++ 编译器为 IntelliSense 提供 C++ 特定的信息,例如系统包含路径的位置和其他设置。有关项目级配置,请参阅 项目级 IntelliSense 配置部分。
C/C++ 扩展何时为我配置核心 IntelliSense 功能?
编译器是配置核心 IntelliSense 功能的唯一要求。为了识别用于 IntelliSense 的编译器,C/C++ 扩展会扫描您机器上的常见路径,以查找诸如 Clang、GCC、MinGW、cygwin、cygwin64 和 MSVC 等编译器。如果识别出任何这些编译器并且它们位于安全位置,它们将自动为 IntelliSense 进行配置。否则,将显示一条通知,要求您确认应将此编译器配置用于 IntelliSense。在这两种情况下,选择的编译器也会被设置为默认编译器。
如何检查 IntelliSense 是否已配置
如果您没有配置 IntelliSense,C/C++ 扩展会在状态栏中显示一个带有警告标志的黄色指示器,标签为 配置 IntelliSense。

要进行配置,请选择状态栏指示器,这将调出配置快速选择。快速选择可以帮助您选择或安装 C/C++ 编译器。
如果您没有看到状态栏指示器,您也可以检查项目的 c_cpp_properties.json 文件。此文件存储了您的所有 IntelliSense 配置设置。通过从命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))选择 C/C++: 编辑配置 (UI) 来导航到此文件。检查 IntelliSense mode 以找到您的配置。

如何配置 IntelliSense
IntelliSense 配置存储在 c_cpp_properties.json 文件中,该文件会自动在您的工作区中创建。以下所有三个选项都是编辑 c_cpp_properties.json 文件的不同方法
选项 1. 通过配置快速选择选择一个配置选项
在命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中输入 选择 IntelliSense 配置 来打开快速选择,它会向您显示一个下拉列表,其中包含 C/C++ 扩展在您的机器上找到的所有配置选项。

选择一个可用选项。如果您选择一个编译器,该编译器将默认由 IntelliSense 使用。您可以随时返回到 配置 IntelliSense 快速选择,以更改用于配置 IntelliSense 的选项。
如果快速选择中没有任何可用选项,则表示在您的系统中未识别出任何编译器。您可以手动浏览机器或安装 C/C++ 编译器。要在 Windows 机器上安装,请选择 帮助我安装编译器 选项,该选项会将您重定向到有关如何安装 C/C++ 编译器的分步指南。在 macOS 或 Linux 机器上,选择 安装编译器 并按照提示操作,即可在您的机器上安装 C++ 编译器。
选项 2. 通过 UI 编辑 IntelliSense 配置
通过从命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))选择 C/C++: 编辑配置 (UI) 来打开 IntelliSense 配置。此视图是 c_cpp_properties.json 文件的用户界面。

将 编译器路径 字段设置为您用于构建项目的编译器的完整路径。例如,在使用 Linux 上 GCC 的默认安装路径时,编译器路径是 /usr/bin/gcc。将 IntelliSense 模式 设置为您使用的编译器的特定于架构的变体。
选项 3. 直接编辑 c_cpp_properties.json 文件
您可以直接编辑 c_cpp_properties.json 文件以自定义配置。使用命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中的 C/C++ 编辑配置 (JSON) 命令,然后 c_cpp_properties.json 文件将在您工作区的 .vscode 文件夹中创建。

使用 compilerPath 变量添加编译器。此变量是您用于构建项目的编译器的完整路径。例如,在使用 Linux 上 GCC 的默认安装路径时,编译器路径是 /usr/bin/gcc。
有关 c_cpp_properties.json 文件的更多信息,请查看 架构参考。
根据您的操作系统选择下面的示例,以获取 c_cpp_configuration.json 文件
> Windows 上的 Sample c_cpp_configuration.json 示例
使用 MinGW 的默认安装路径
{
"configurations": [
{
"name": "Win32",
"includePath": ["${workspaceFolder}/**"],
"defines": ["_DEBUG", "UNICODE", "_UNICODE"],
"windowsSdkVersion": "10.0.22621.0",
"cStandard": "c17",
"cppStandard": "c++17",
"intelliSenseMode": "${default}",
"compilerPath": "C:/msys64/mingw64/bin/gcc.exe"
}
],
"version": 4
}
> macOS 上的 Sample c_cpp_configuration.json 示例
使用 Clang 的默认安装路径
{
"configurations": [
{
"name": "Mac",
"includePath": ["${workspaceFolder}/**"],
"defines": [],
"macFrameworkPath": [
"/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks"
],
"compilerPath": "/usr/bin/clang",
"cStandard": "c17",
"cppStandard": "c++17",
"intelliSenseMode": "macos-clang-arm64"
}
],
"version": 4
}
> Linux 上的 Sample c_cpp_configuration.json 示例
使用 GCC 的默认安装路径
{
"configurations": [
{
"name": "Linux-GCC",
"includePath": ["${workspaceFolder}/**"],
"defines": [],
"compilerPath": "/usr/bin/g++",
"cStandard": "c17",
"cppStandard": "c++17",
"intelliSenseMode": "gcc-x64",
"browse": {
"path": ["${workspaceFolder}"],
"limitSymbolsToIncludedHeaders": true,
"databaseFilename": ""
}
}
],
"version": 4
}
项目级 IntelliSense 配置
使用编译器配置 IntelliSense 会为您提供核心 IntelliSense 功能。这种设置称为基本配置。对于更复杂的用法场景,例如设置需要
- 其他 include 路径,例如对一个或多个不同库的引用
- 影响语言(以及 IntelliSense)行为的特定编译器参数
还有多种其他方法可以配置 IntelliSense。您可以通过以下方式提供这些附加配置
c_cpp_properties.json文件和相关设置- 另一种 VS Code 扩展形式的自定义配置提供程序(例如,Makefile Tools 或 CMake Tools 扩展)
compile_commands.json文件
配置提供程序
自定义配置提供程序是 VS Code 中的另一个扩展,它可能比 C/C++ 扩展提供更准确的 C++ IntelliSense 配置。例如,对于 CMake 或 Make 构建系统,Makefile Tools 或 CMake Tools 扩展可以作为配置提供程序。要添加扩展作为配置提供程序,请通过配置快速选择选择该扩展,通过编辑 高级设置 下的 配置提供程序 字段将其添加到配置 UI,或将 configurationProvider 字段添加到 c_cpp_properties.json 文件中。例如,对于 CMake 扩展,要添加的路径是 ms-vscode.cmake-tools。

C/C++ 扩展会扫描您的系统以查找自定义配置提供程序。如果它只识别出一个自定义配置提供程序,该配置提供程序会自动为 IntelliSense 进行配置。如果有多个配置提供程序被识别,您需要通过打开配置快速选择来选择扩展应该使用哪一个。
compile_commands.json 文件
提供 IntelliSense 配置的另一种选择是 compile_commands.json 文件,它描述了用于项目中每个文件的确切编译命令。此文件通常由构建系统(如 CMake 或 Bazel)生成,方法是在配置项目时设置命令行参数。可以通过与 如何配置 IntelliSense 部分中讨论的相同方法通过配置快速选择、通过 UI 编辑配置或直接编辑 c_cpp_properties.json 文件来选择 compile_commands.json 文件进行配置。在配置 UI 中,可以在 高级配置 和 编译命令 字段下添加该文件。例如,如果您的 compile_commands.json 文件位于工作区根目录,请在 编译命令 字段中输入 ${workspaceFolder}/compile_commands.json。否则,可以使用 compileCommands 配置属性直接将其添加到 c_cpp_properties.json 文件中。
如果编译命令数据库不包含与您在编辑器中打开的文件相对应的翻译单元的条目,则改用您的基本配置(在 c_cpp_properties.json 中找到)(例如您的 includePath 和 defines)。如果 C/C++ 扩展恢复到基本配置,语言状态栏指示器将在状态栏中显示标签 配置 IntelliSense。
如果您指定了自定义配置提供程序和 compile_commands.json 文件,则会首先查询自定义配置提供程序以获取 IntelliSense 配置。
如果您的程序包含不在您的工作区中或不在标准库路径中的头文件,您可以修改 Include Path。C/C++ 扩展通过查询 Compiler path 指定的编译器来填充 include 路径。如果扩展找不到目标系统库的路径,您可以手动输入 include 路径。
使用语言状态栏检查 IntelliSense 活动
您可以使用语言状态栏确定 IntelliSense 是否正在积极处理您的文件。要调用语言状态栏,请打开一个 C++ 文件。状态栏显示文本 {} C++。将鼠标悬停在 {} 符号上以打开语言状态栏浮出窗口。浮出窗口中的第一项指示 IntelliSense 状态。以下是不同的状态及其含义
- IntelliSense: 就绪 = IntelliSense 已为 C/C++ 扩展配置,并且在您与编辑器交互时(例如,通过编写代码)自动激活。
- IntelliSense: 正在更新 = IntelliSense 正在根据您对代码所做的更改积极工作以确定任何代码补全、语法高亮显示等。

您可以选择语言状态栏浮出窗口中任何项目右侧的图钉图标,将其永久固定到您的状态栏。
后续步骤
- 有关 IntelliSense 配置的更多信息,请参阅 自定义默认设置。
- 如果您在配置设置时遇到问题,请在 GitHub 讨论区发起讨论,或者如果您发现需要修复的问题,请在 GitHub 问题中提交问题。
- 浏览 c_cpp_properties 架构。
- 查看 C++ 扩展概述。