Visual Studio Code

c_cpp_properties.json 参考

本文解释了c_cpp_properties.json设置文件的方案。

想要开始配置您的项目吗？请参阅配置Intellisense。有关更改这些设置的更多信息，请参阅自定义默认设置。

变量示例

注意，这是一个所有字段的示例。您不需要在c_cpp_properties.json文件中指定所有字段。扩展程序将自动用默认值填充任何缺失的字段。

{
  "env": {
    "myIncludePath": ["${workspaceFolder}/include", "${workspaceFolder}/src"],
    "myDefines": ["DEBUG", "MY_FEATURE=1"]
  },
  "configurations": [
    {
      "name": "Linux",
      "compilerPath": "/usr/bin/gcc",
      "compilerArgs": ["-m32"],
      "intelliSenseMode": "linux-gcc-x86",
      "includePath": ["${myIncludePath}", "/usr/include"],
      "defines": ["${myDefines}"],
      "cStandard": "gnu11",
      "cppStandard": "gnu++14",
      "configurationProvider": "ms-vscode.cmake-tools",
      "forcedInclude": ["${workspaceFolder}/common.h"],
      "compileCommands": "${workspaceFolder}/build/compile_commands.json",
      "dotConfig": "${workspaceFolder}/.config",
      "mergeConfigurations": true,
      "customConfigurationVariables": {
        "myVar": "myvalue"
      },
      "browse": {
        "path": ["${myIncludePath}", "/usr/include", "${workspaceFolder}"],
        "limitSymbolsToIncludedHeaders": true,
        "databaseFilename": "${workspaceFolder}/.vscode/browse.vc.db"
      }
    },
    {
      "name": "Mac",
      "compilerPath": "/usr/bin/clang",
      "intelliSenseMode": "macos-clang-x64",
      "includePath": ["${myIncludePath}"],
      "defines": ["${myDefines}"],
      "cStandard": "c11",
      "cppStandard": "c++17",
      "macFrameworkPath": ["/System/Library/Frameworks", "/Library/Frameworks"],
      "browse": {
        "path": ["${myIncludePath}", "${workspaceFolder}"]
      }
    },
    {
      "name": "Win32",
      "compilerPath": "C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/VC/Tools/MSVC/14.28.29333/bin/Hostx64/x64/cl.exe",
      "intelliSenseMode": "windows-msvc-x64",
      "includePath": ["${myIncludePath}"],
      "defines": ["${myDefines}", "_WINDOWS"],
      "cStandard": "c17",
      "cppStandard": "c++20",
      "windowsSdkVersion": "10.0.19041.0",
      "browse": {
        "path": ["${myIncludePath}", "${workspaceFolder}"]
      }
    }
  ],
  "version": 4,
  "enableConfigurationSquiggles": true
}

顶级属性

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

  • configurations 一个配置对象数组，为IntelliSense引擎提供有关您的项目和偏好的信息。默认情况下，扩展程序会根据您的操作系统为您创建一个配置。您也可以添加其他配置。

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

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

配置属性

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

  • compilerPath（可选） 您用于构建项目的编译器的完整路径，例如/usr/bin/gcc，以启用更准确的IntelliSense。扩展将查询编译器以确定用于IntelliSense的系统包含路径和默认定义。

    将"compilerPath": ""（空字符串）设置为空字符串将跳过查询编译器。如果指定的编译器不支持用于查询的参数，这将非常有用，因为扩展将默认回退到它可以找到的任何编译器（如Visual C）。省略compilerPath属性不会跳过查询。

  • compilerArgs（可选） 用于修改包含或定义的编译器参数，例如-nostdinc++，-m32等。需要额外空格分隔的参数应作为数组中的单独参数输入，例如，对于--sysroot ，使用\"--sysroot\", \"\"。

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

    平台默认值：

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

    仅指定-变体（例如，gcc-x64）的IntelliSense模式是旧模式，并且会根据主机平台自动转换为--变体。

  • includePath 包含路径是一个包含头文件的文件夹（例如 #include "myHeaderFile.h"），这些头文件被包含在源文件中。为 IntelliSense 引擎指定一个路径列表，用于搜索包含的头文件。在这些路径上的搜索不是递归的。指定 ** 表示递归搜索。例如，${workspaceFolder}/** 将搜索所有子目录，而 ${workspaceFolder} 则不会。如果在 Windows 上安装了 Visual Studio，或者在 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 可以提供源代码文件智能感知配置信息的VS Code扩展的ID。例如，使用VS Code扩展ID ms-vscode.cmake-tools来提供来自CMake Tools扩展的配置信息。如果您指定了configurationProvider，它提供的配置将优先于您在c_cpp_properties.json中的其他设置。

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

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

  • macFrameworkPath IntelliSense 引擎在搜索来自 Mac 框架的包含头文件时使用的路径列表。仅在 macOS 配置上支持。

  • forcedInclude（可选） 一个文件列表，这些文件应在处理源文件中的任何其他字符之前被包含。文件按列出的顺序包含。

  • compileCommands（可选） 工作空间的compile_commands.json文件的完整路径。如果在编辑器中打开的文件在compile_commands.json中有匹配的条目，则该命令行将用于为该文件配置IntelliSense，而不是使用c_cpp_properties.json的其他字段。 有关文件格式的更多信息，请参阅Clang文档。一些构建系统，如CMake，简化了生成此文件的过程。

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

  • mergeConfigurations 设置为true以合并包含路径、定义和强制包含与配置提供者的内容。

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

  • browse 当"C_Cpp.intelliSenseEngine"设置为"Tag Parser"（也称为“模糊”IntelliSense或“浏览”引擎）时使用的一组属性。这些属性也被转到定义/声明功能使用，或者当“默认”IntelliSense引擎无法解析源文件中的#includes时使用。

浏览属性

  • path Tag Parser 用于搜索源文件包含的头文件的路径列表。如果省略，将使用 includePath 作为 path。默认情况下，这些路径的搜索是递归的。指定 * 表示非递归搜索。例如：${workspaceFolder} 将搜索所有子目录，而 ${workspaceFolder}/* 则不会。

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

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

支持的变量

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

10/31/2023