CppProperties.json referência

Projetos de pasta aberta que não usam o CMake podem armazenar definições de configuração de projeto para o IntelliSense em um CppProperties.json arquivo. (Os projetos CMake usam um CMakeSettings.json arquivo.) Uma configuração consiste em pares nome/valor e define caminhos #include, opções de compilador e outros parâmetros. Para obter mais informações sobre como adicionar configurações em um projeto de pasta aberta, consulte Projetos de pasta aberta para C++. As seções a seguir resumem as várias configurações. Para obter uma descrição completa do esquema, navegue até CppProperties_schema.json, cujo caminho completo é dado na parte superior do editor de código quando CppProperties.json está aberto.

Propriedades de configuração

Uma configuração pode ter qualquer uma das seguintes propriedades:

valores do "intelliSenseMode"

O editor de código mostra as opções disponíveis quando você começa a digitar:

Esta lista mostra os valores suportados:

• windows-msvc-x86
• windows-msvc-x64
• windows-msvc-arm
• windows-msvc-arm64
• android-clang-x86
• android-clang-x64
• android-clang-arm
• android-clang-arm64
• ios-clang-x86
• ios-clang-x64
• ios-clang-arm
• ios-clang-arm64
• windows-clang-x86
• windows-clang-x64
• windows-clang-arm
• windows-clang-arm64
• linux-gcc-x86
• linux-gcc-x64
• linux-gcc-arm

Nota: Os valores msvc-x86 e msvc-x64 são suportados apenas por motivos herdados. Em vez disso, use as variantes windows-msvc-*.

Ambientes pré-definidos

Visual Studio fornece os seguintes ambientes predefinidos para o Microsoft C++ que correspondem ao prompt de comando do desenvolvedor correspondente. Ao herdar um desses ambientes, você pode fazer referência a qualquer uma das variáveis de ambiente usando a propriedade env global com esta sintaxe de macro: ${env.VARIABLE}.

Quando a carga de trabalho do Linux é instalada, os seguintes ambientes estão disponíveis para acesso remoto ao Linux e WSL:

Ambientes definidos pelo usuário

Opcionalmente, você pode usar a environments propriedade para definir conjuntos de variáveis globalmente CppProperties.json ou por configuração. Essas variáveis se comportam como variáveis de ambiente no contexto de um projeto Open Folder. Você pode acessá-los com a ${env.VARIABLE} sintaxe de tasks.vs.json e launch.vs.json depois que eles são definidos aqui. No entanto, eles não são necessariamente definidos como variáveis de ambiente reais em qualquer prompt de comando que o Visual Studio usa internamente.

Visual Studio 2019 versão 16.4 e posterior: As variáveis específicas de configuração definidas em CppProperties.json são automaticamente captadas por destinos e tarefas de depuração sem a necessidade de definir inheritEnvironments. Os destinos de depuração são lançados automaticamente com o ambiente que você especificar em CppProperties.json.

Visual Studio 2019 versão 16.3 e anterior: Quando você consome um ambiente, então você tem que especificá-lo na inheritsEnvironments propriedade, mesmo que o ambiente seja definido como parte da mesma configuração, a environment propriedade especifica o nome do ambiente. O exemplo a seguir mostra uma configuração de exemplo para habilitar o IntelliSense para GCC em uma instalação MSYS2. Observe como a configuração define e herda o mingw_64 ambiente e como a includePath propriedade pode acessar a INCLUDE variável.

"configurations": [
    {

      "inheritEnvironments": [
        "mingw_64"
      ],
      "name": "Mingw64",
      "includePath ,": [
        "${env.INCLUDE}",
        "${workspaceRoot}\\**",
      ],
      "intelliSenseMode": "linux-gcc-x64",
      "environments": [
        {
          "MINGW64_ROOT": "C:\\msys64\\mingw64",
          "BIN_ROOT": "${env.MINGW64_ROOT}\\bin",
          "FLAVOR": "x86_64-w64-mingw32",
          "TOOLSET_VERSION": "9.1.0",
          "PATH": "${env.MINGW64_ROOT}\\bin;${env.MINGW64_ROOT}\\..\\usr\\local\\bin;${env.MINGW64_ROOT}\\..\\usr\\bin;${env.MINGW64_ROOT}\\..\\bin;${env.PATH}",
          "INCLUDE": "${env.MINGW64_ROOT}\\include\\c++\\${env.TOOLSET_VERSION};${env.MINGW64_ROOT}\\include\\c++\\${env.TOOLSET_VERSION}\\tr1;${env.MINGW64_ROOT}\\include\\c++\\${env.TOOLSET_VERSION}\\${env.FLAVOR};",
          "environment": "mingw_64"
        }
      ]
    }
  ]

Quando você define uma "environments" propriedade dentro de uma configuração, ela substitui todas as variáveis globais que têm os mesmos nomes.

Macros incorporadas

Você tem acesso às seguintes macros internas dentro CppProperties.json:

Exemplo

Se o seu projeto tiver uma pasta include e também incluir *windows.h* e outros cabeçalhos comuns do SDK do Windows, convém atualizar o seu arquivo de configuração CppProperties.json com as seguintes inclusões:

{
  "configurations": [
    {
      "name": "Windows",
      "includePath": [
        // local include folder
        "${workspaceRoot}\\include",
        // Windows SDK and CRT headers
        "${env.WindowsSdkDir}\\include\\${env.WindowsSDKVersion}\\ucrt",
        "${env.NETFXSDKDir}\\include\\um",
        "${env.WindowsSdkDir}\\include\\${env.WindowsSDKVersion}\\um",
        "${env.WindowsSdkDir}\\include\\${env.WindowsSDKVersion}\\shared",
        "${env.VCToolsInstallDir}\\include"
      ]
    }
  ]
}

Solucionar problemas de erros do IntelliSense

Se não estiver a ver o IntelliSense esperado, pode resolver problemas acedendo a Tools>Options>Text Editor>C/C++>Advanced e definindo Enable Logging to true. Para começar, tente definir Nível de Log como 5 e Filtros de Log como 8.

A saída é canalizada para a janela de saída e é visível quando você escolhe Mostrar saída de: Visual C++ Log. A saída contém, entre outras coisas, a lista de caminhos de inclusão reais que o IntelliSense está tentando usar. Se os caminhos não corresponderem aos de CppProperties.json, tenta fechar a pasta e eliminar a subpasta .vs que contém dados de navegação em cache.

Para solucionar erros do IntelliSense causados por caminhos de inclusão ausentes, abra a guia Lista de erros e, em seguida, filtre sua saída para "Somente IntelliSense" e o código de erro E1696 "não é possível abrir o arquivo de origem ...".