现已发布！阅读关于 11 月新增功能和修复的内容。

C++ 扩展设置参考

C++ 扩展设置高度可配置。本文档将介绍 c_cpp_properties.json 文件的架构。有关 VS Code 中设置的常规信息，请参阅 配置设置，以及 变量参考 和 VS Code 默认设置。

想开始配置 C++ 项目？请先从 配置 IntelliSense 开始。

变量示例

以下 JSON 代码片段是 c_cpp_properties.json 的示例配置。您只需在 JSON 文件中包含相关的变量，任何缺失的字段都将由 C++ 扩展用其默认值填充。

{
  "env": {
    "myIncludePath": ["${workspaceFolder}/include", "${workspaceFolder}/src"],
    "myDefines": ["DEBUG", "MY_FEATURE=1"]
  },
  "configurations": [
    {
      "name": "Mac",
      "compilerPath": "/usr/bin/clang++",
      "intelliSenseMode": "macos-clang-x64",
      "includePath": ["${myIncludePath}", "${workspaceFolder}/**"],
      "defines": ["${myDefines}"],
      "cStandard": "c17",
      "cppStandard": "c++20",
      "macFrameworkPath": ["/System/Library/Frameworks", "/Library/Frameworks"],
      "browse": {
        "path": ["${myIncludePath}", "${workspaceFolder}"]
      }
    }
  ],
  "version": 4,
  "enableConfigurationSquiggles": true
}

顶层属性

  • env：用户定义的变量数组，可通过标准环境变量语法 ${<var>} 或 ${env:<var>} 在配置中进行替换。接受字符串和字符串数组。

  • configurations：配置对象数组，为 IntelliSense 引擎提供有关您的项目和首选项的信息。默认情况下，扩展会根据您的操作系统为您创建一个配置。您还可以添加更多配置。

  • version：我们建议您不要编辑此字段。它跟踪 c_cpp_properties.json 文件的当前版本，以便扩展知道应存在哪些属性和设置，以及如何将此文件升级到最新版本。

  • enableConfigurationSquiggles：设置为 true 可将 c_cpp_properties.json 文件中检测到的错误报告给 C++ 扩展。

配置属性

  • name：一个用户友好的名称，用于标识配置。Linux、Mac 和 Win32 是配置的特殊标识符，它们会在这些平台上自动选择。VS Code 的状态栏会显示当前活动的配置。您也可以在状态栏中选择标签来更改活动配置。

  • compilerPath：用于构建项目的编译器的完整路径，例如 /usr/bin/gcc，以实现更准确的 IntelliSense。扩展会查询编译器以确定 IntelliSense 所使用的系统包含路径和默认定义。

    将 "compilerPath": ""（空字符串）设置为跳过查询编译器。这对于您偏好的编译器不支持用于查询的参数很有用，因为扩展会自动选择它能找到的任何支持的编译器（例如 MSVC）。省略 compilerPath 属性不会跳过查询。

  • compilerArgs：用于修改包含路径或定义的编译器参数，例如 -nostdinc++、-m32 等。需要额外空格分隔参数的参数应作为单独的参数输入到数组中，例如，对于 --sysroot <arg>，请使用 \"--sysroot\", \"<arg>\"。

  • intelliSenseMode：要使用的 IntelliSense 模式，映射到 MSVC、gcc 或 Clang 的特定于体系结构的变体。如果未设置或设置为 ${default}，则扩展会选择该平台的默认值。

    平台默认值

    • Windows：windows-msvc-x64
    • Linux：linux-gcc-x64
    • macOS：macos-clang-x64

    仅指定 <compiler>-<architecture> 变体（例如 gcc-x64）的 IntelliSense 模式是旧版模式，它们会根据主机平台自动转换为 <platform>-<compiler>-<architecture> 变体。

  • includePath：包含路径是头文件目录，源文件会包含这些头文件。例如，源文件包含 include 指令 #include "myHeaderFile.h"，将此头文件的路径添加到 includePath。为 IntelliSense 引擎指定要使用的路径列表，以在查找包含的头文件时使用。这些路径上的搜索不是递归的。在路径末尾指定 /** 表示递归搜索。例如，${workspaceFolder}/** 会搜索所有子目录，而 ${workspaceFolder} 则不会。如果您使用的是安装了 Visual Studio 的 Windows 系统，或者在 compilerPath 设置中指定了编译器，则不应在此处列出系统包含路径。

  • defines：供 IntelliSense 引擎在解析文件时使用的预处理器定义列表。可选地，使用 = 来设置值，例如 VERSION=1。

  • cStandard：用于 IntelliSense 的 C 语言标准版本。例如，c17、gnu23 或 ${default}。注意：GNU 标准仅用于查询设置的编译器以获取 GNU 定义，IntelliSense 会模拟等效的 C 标准版本。

  • cppStandard：用于 IntelliSense 的 C++ 语言标准版本。例如，c++20、gnu++23 或 ${default}。注意：GNU 标准仅用于查询设置的编译器以获取 GNU 定义，IntelliSense 会模拟等效的 C++ 标准版本。

  • configurationProvider：可以为源文件提供 IntelliSense 配置信息的 VS Code 扩展的 ID。例如，使用 VS Code 扩展 ID ms-vscode.cmake-tools 来提供 CMake Tools 扩展的配置信息。如果您指定了 configurationProvider，它提供的配置将优先于您在 c_cpp_properties.json 中的其他设置。

    configurationProvider 候选扩展必须实现 vscode-cpptools-api。

  • mergeConfigurations：设置为 true 以合并来自配置提供程序的包含路径、定义和强制包含。

  • windowsSdkVersion：在 Windows 上使用的 Windows SDK 包含路径的版本，例如 10.0.17134.0。

  • macFrameworkPath：供 IntelliSense 引擎在查找 Mac 框架的包含头文件时使用的路径列表。

  • forcedInclude：在处理源文件中的任何文本之前应包含的文件列表。文件按列出的顺序包含。

  • compileCommands：包含工作区 compile_commands.json 文件完整路径的路径数组。如果在编辑器中打开的文件与 compile_commands.json 中的某个条目匹配，则将使用该命令行为 IntelliSense 配置该文件，而不是使用 c_cpp_properties.json 中的其他字段。有关文件格式的更多信息，请参阅 Clang 文档。某些构建系统，如 CMake，可以简化此文件的生成。

  • dotConfig：Kconfig 系统创建的 .config 文件的路径。Kconfig 系统会生成一个包含构建项目所需的所有定义的文件的文件。使用 Kconfig 系统的项目示例包括 Linux Kernel 和 NuttX RTOS。

  • customConfigurationVariables：可以通过命令 ${cpptools:activeConfigCustomVariable} 查询的自定义变量，用于 launch.json 或 tasks.json 中的输入变量。

  • browse：与 IntelliSense 结合使用的属性集，用于识别代码库中的所有符号。这些属性由“转到定义/声明”、“全局符号搜索”等功能使用，或者在“默认”IntelliSense 引擎无法解析源文件中的 #includes 时使用。

  • recursiveIncludes：用于配置扩展如何处理指定递归搜索的 includePath 条目的属性集。

浏览属性

  • path：源文件将被解析以用于全局符号搜索的路径列表。如果省略，则 includePath 用作 path。这些路径上的搜索默认是递归的。指定 * 表示非递归搜索。例如，${workspaceFolder} 会搜索所有子目录，而 ${workspaceFolder}/* 则不会。

  • limitSymbolsToIncludedHeaders：当设置为 true 时，Tag Parser 只解析源文件中直接或间接包含的头文件（位于 ${workspaceFolder}）。当设置为 false 时，Tag Parser 会解析 browse.path 列表中指定的所有代码文件。

  • databaseFilename：生成的符号数据库的路径。此属性指示扩展将工作区符号数据库保存在工作区默认存储位置之外的其他位置。如果指定了相对路径，则该路径相对于工作区的默认存储位置，而不是工作区文件夹本身。${workspaceFolder} 变量可用于指定相对于工作区文件夹的路径（例如 ${workspaceFolder}/.vscode/browse.vc.db）。

递归包含属性

  • reduce：当展开递归 includePath 条目时，可能会产生大量用于 IntelliSense 处理源代码文件中的 #include 语句的包含路径。将大量包含路径发送到 IntelliSense 编译器可能会影响某些系统的 IntelliSense 性能。默认情况下，扩展会通过首先标记解析源文件来搜索 #include 语句并确定所需包含路径，从而将包含路径集减少到最小可能的集合。此减少过程与此设置的 always 选项具有相同的行为。此行为会折衷一些初始开销，以便 IntelliSense 以后可能更快。将此属性设置为 never 将向 IntelliSense 进程提供包含路径的完整递归展开。通过不预先解析任何文件，此行为会折衷潜在的后续性能，以确保在打开源文件时 IntelliSense 可以更快地启动。总的来说，减少配置中递归包含路径的数量可能会提高涉及大量路径时的 IntelliSense 性能。

  • priority：在解析 #include 语句时递归包含路径搜索的优先级。如果设置为 beforeSystemIncludes，则在系统包含路径之前搜索递归包含路径。如果设置为 afterSystemIncludes，则在系统包含路径之后搜索递归包含路径。beforeSystemIncludes 更接近编译器搜索顺序，更具可预测性，而 afterSystemIncludes 可能会提高性能。

  • order：递归包含的子目录是按 breadthFirst（广度优先）还是 depthFirst（深度优先）进行搜索。

支持的变量

您可以通过在 tasks.json 或 launch.json 脚本中使用变量 ${command:cpptools.activeConfigName}，允许 tasks.json 或 launch.json 查询 c_cpp_properties.json 中的当前活动配置。

VS Code 默认设置

c_cpp_properties.json 支持所有 VS Code 默认设置，例如 C_Cpp.default.includePath。唯一的例外是

C_Cpp.default.systemIncludePath : string[]

此设置允许您将系统包含路径与包含路径分开指定。但是，C++ 扩展从编译器接收到的选定的系统包含路径不会传递给 IntelliSense 进程。这仅在罕见情况下使用，因为它会覆盖标准的编译器行为，例如，如果您的编译器不受支持。相反，请使用 compilerArgs 设置并使用 -isystem 标志指定系统头文件，这在大多数情况下是更好的解决方案。

4/25/2025
English 한국어 中文(简体)
© . This site is unofficial and not affiliated with Microsoft.