現已釋出！閱讀關於 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
© . This site is unofficial and not affiliated with Microsoft.