下面是一個通用模板,適用于大多數使用 VSCode + CMake + Ninja + MinGW/GCC 編譯器 的 C++ 或 Qt 項目。你可以將這個 .vscode
文件夾復制到你的項目根目錄下,稍作路徑調整即可使用。
📁 .vscode/
目錄結構(通用模板)
.vscode/
├── settings.json # 工作區設置(CMake 配置)
├── tasks.json # 構建任務配置(CMake Configure & Build)
└── launch.json # 調試器配置(GDB)
? 1. settings.json
{"cmake.generator": "Ninja","cmake.configureOnOpen": true,"cmake.buildDirectory": "${workspaceFolder}/build","cmake.clearOutputBeforeBuild": true,"cmake.useCmakeListsTxt": true,"files.exclude": {"**/.git": true,"**/.DS_Store": true,"**/__pycache__": true},"editor.tabSize": 4,"editor.formatOnSave": true
}
?? 說明:
- 使用 Ninja 作為生成器;
- 打開項目時自動配置 CMake;
- 構建輸出目錄為
build/
; - 排除一些不必要的文件顯示在資源管理器中;
- 設置默認縮進為 4 空格,保存時格式化代碼。
? 2. tasks.json
{"version": "2.0.0","tasks": [{"label": "CMake: Configure","type": "shell","command": "cmake","args": ["-B", "${workspaceFolder}/build", "-G", "Ninja"],"group": { "kind": "build", "isDefault": true },"problemMatcher": ["$cmake"]},{"label": "CMake: Build","type": "shell","command": "cmake","args": ["--build", "${workspaceFolder}/build"],"group": { "kind": "build", "isDefault": true },"problemMatcher": ["$cmake"]},{"label": "CMake: Clean","type": "shell","command": "rm -rf build/*"}]
}
?? 說明:
CMake: Configure
:運行cmake -B build -G Ninja
來配置構建系統;CMake: Build
:運行cmake --build build
進行編譯;CMake: Clean
:清理構建目錄(僅限 Unix-like 系統);- 如果你在 Windows 上使用 CMD 或 PowerShell,可以用如下命令代替:
rd /s /q build && mkdir build
? 3. launch.json
{"version": "0.2.0","configurations": [{"name": "GDB Debug","type": "cppdbg","request": "launch","program": "${workspaceFolder}/build/myapp.exe","args": [],"stopAtEntry": false,"cwd": "${workspaceFolder}","environment": [],"externalConsole": true,"MIMode": "gdb","miDebuggerPath": "C:\\msys64\\mingw64\\bin\\gdb.exe"}]
}
?? 說明:
"program"
是你要調試的可執行文件路徑;"miDebuggerPath"
根據你安裝的 GDB 路徑修改;- 如果你用的是 MSYS2 或 MinGW-w64,請確認
gdb.exe
存在; - 如果你用的是 MSVC(Visual Studio 編譯器),則需要使用
Windows Debugger
插件。
- 如果你用的是 MSYS2 或 MinGW-w64,請確認
🧪 使用方法
- 把這三個文件放到你的項目根目錄下的
.vscode/
文件夾中; - 確保你的項目根目錄有
CMakeLists.txt
; - 按
Ctrl+Shift+P
,輸入并運行CMake: Configure
; - 按
Ctrl+Shift+B
構建項目; - 按
F5
啟動調試器;
📦 可選建議(針對 Qt 項目)
如果你是 Qt 項目,確保 CMakeLists.txt
中包含以下內容:
set(CMAKE_INCLUDE_CURRENT_DIR ON)
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)
set(CMAKE_AUTOUI ON)find_package(Qt6 COMPONENTS Widgets REQUIRED)target_link_libraries(myapp PRIVATE Qt6::Widgets)
📝 提示:路徑問題要特別注意!
miDebuggerPath
要根據你實際安裝路徑填寫;program
要指向你生成的.exe
文件路徑;- 如果你不知道路徑,可以在終端中運行:
which gdb
🎁 小福利:一鍵創建腳本(可選)
如果你經常新建項目,可以寫一個 Python 或 Shell 腳本來自動生成 .vscode
文件夾和配置。
VSCode 工作區配置文件通用模板創建腳本