在 VS Code 中尝试 ！

C++ 扩展设置参考

C++ 扩展设置具有高度的可配置性。本文解释了 c_cpp_properties.json 文件的架构。有关 VS Code 中设置的一般信息，请参阅配置设置，以及变量参考和默认 VS Code 设置。

想开始配置您的 C++ 项目？请从配置智能感知开始。

变量示例

以下 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：一个包含配置对象的数组，这些对象向智能感知引擎提供有关您的项目和偏好的信息。默认情况下，扩展会根据您的操作系统为您创建一个配置。您还可以添加更多配置。

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

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

配置属性

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

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

    设置 "compilerPath": ""（空字符串）会跳过查询编译器。如果您的首选编译器不支持用于查询的参数，这会很有用，因为扩展会默认使用它可以找到的任何受支持的编译器（例如 MSVC）。省略 compilerPath 属性不会跳过查询。

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

  • intelliSenseMode：要使用的智能感知模式，它映射到特定架构的 MSVC、gcc 或 Clang 变体。如果未设置或设置为 ${default}，扩展将选择该平台的默认模式。

    平台默认值

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

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

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

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

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

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

  • configurationProvider：可以为源文件提供智能感知配置信息的 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：智能感知引擎在搜索 Mac 框架中包含的头文件时使用的路径列表。

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

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

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

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

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

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

浏览属性

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

  • limitSymbolsToIncludedHeaders：当设置为 true 时，标签解析器仅解析 ${workspaceFolder} 中源文件直接或间接包含的头文件。当设置为 false 时，标签解析器解析在 browse.path 列表中指定路径下找到的所有代码文件。

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

递归包含属性

  • reduce：当递归的 includePath 条目展开时，它可能导致智能感知在解析源文件中的 #include 语句时处理大量包含路径。将大量包含路径发送给智能感知编译器可能会影响智能感知在某些系统上的性能。默认情况下，扩展会通过首先标签解析源文件来搜索 #include 语句并确定需要哪些包含路径，从而将包含路径集减少到最小。此减少过程与此设置的 always 选项行为相同。此行为牺牲一些初始开销，以便智能感知以后可能更快。将此属性设置为 never 将向智能感知进程提供包含路径的完整递归展开。通过不预先解析任何文件，此行为牺牲后期的潜在性能，以确保在打开源文件时智能感知可以更快地启动。通常，减少配置中递归包含路径的数量可能会在涉及大量路径时提高智能感知的性能。

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

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

支持的变量

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

默认 VS Code 设置

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

C_Cpp.default.systemIncludePath : string[]

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

4/25/2025