配置 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 模式
以找到您的配置。要详细了解 c_cpp_properties.json
文件,可以查看 架构参考。
如何配置 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)”命令,然后在工作区的 .vscode
文件夹中创建 c_cpp_properties.json
文件。
使用 compilerPath
变量添加编译器。此变量是用于构建项目的编译器的完整路径。例如,在使用 Linux 上 GCC 的默认安装路径时,编译器路径为 /usr/bin/gcc
。
有关 c_cpp_properties.json
文件的更多信息,请查看 架构参考。
根据您的操作系统选择以下示例,以获取 c_cpp_configuration.json
文件
> Windows 上的示例 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 上的示例 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 上的示例 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 功能。此设置称为基本配置。对于更复杂的用法场景,例如设置需要以下内容的项目:
- 附加包含路径,例如对一个或多个不同库的引用
- 影响语言行为(以及 IntelliSense)的特定编译器参数
有许多其它方法可以配置 IntelliSense。您可以通过以下方式提供这些附加配置:
c_cpp_properties.json
文件和相关设置- 以另一个 VS Code 扩展形式的自定义配置提供程序(例如,Makefile 工具 或 CMake 工具 扩展)
compile_commands.json
文件
配置提供程序
自定义配置提供程序是 VS Code 中的另一个扩展,它可能比 C/C++ 扩展提供更准确的 C++ IntelliSense 配置。例如,对于 CMake 或 Make 构建系统,Makefile 工具 或 CMake 工具 扩展可以作为配置提供程序。要添加扩展作为配置提供程序,可以通过配置快速选择选择扩展,通过编辑“高级设置”下的“配置提供程序”字段将其添加到配置 UI 中,或者将 configurationProvider
字段添加到 c_cpp_properties.json
文件中。例如,对于 CMake 扩展,要添加的路径为 ms-vscode.cmake-tools
。
C/C++ 扩展会扫描您的系统以查找自定义配置提供程序。如果只识别到一个自定义配置提供程序,该提供程序将自动配置为 IntelliSense。如果识别到多个配置提供程序,您需要通过打开 配置快速选择 来选择扩展应该使用哪个提供程序。
compile_commands.json 文件
另一个提供 IntelliSense 配置的选项是 compile_commands.json 文件,它描述了项目中每个文件的具体编译命令。此文件通常由构建系统(例如 CMake 或 Bazel)在配置项目时设置命令行参数生成。可以通过与“如何配置 IntelliSense”部分中所述相同的方法选择 compile_commands.json
文件进行配置,即通过配置快速选择、通过 UI 编辑配置,或直接编辑 c_cpp_properties.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 配置。
如果您的程序包含不在工作区中或不在标准库路径中的头文件,您可以修改**包含路径**。C/C++ 扩展通过查询由**编译器路径**指定的编译器来填充包含路径。如果扩展无法找到目标系统库的路径,您可以手动输入包含路径。
使用语言状态栏检查 IntelliSense 活动
您可以使用语言状态栏确定 IntelliSense 是否正在您的文件上积极工作。要调用语言状态栏,请打开一个 C++ 文件。状态栏将显示文本 **{} C++**。将鼠标悬停在 **{}** 符号上以打开语言状态栏弹出窗口。弹出窗口中的顶部项目指示 IntelliSense 状态。以下是不同的状态及其含义
- **IntelliSense:已准备就绪** = C/C++ 扩展已配置 IntelliSense,如果您与编辑器交互(例如编写代码),它会自动激活。
- **IntelliSense:正在更新** = IntelliSense 正在积极工作以根据您对代码所做的更改确定任何代码完成、语法高亮等。
您可以选择语言状态栏弹出窗口中任何项目右侧的固定图标,将其永久固定到状态栏中。
下一步
- 有关 IntelliSense 配置的更多信息,请参阅 自定义默认设置。
- 如果您在配置设置时遇到问题,请在 GitHub 讨论 中开始讨论,或者如果您发现需要修复的问题,请在 GitHub 问题 中提交问题。
- 探索 c_cpp_properties 模式。
- 查看 C++ 扩展概述。