如何在 VS Code 中进行 C++ 开发 – wiki基地

如何在 VS Code 中进行高效的 C++ 开发

Visual Studio Code (简称 VS Code) 已经迅速崛起成为最受欢迎的代码编辑器之一。它轻量、高度可扩展，并且通过丰富的扩展生态系统，能够为多种编程语言提供强大的开发体验。对于 C++ 开发者而言，VS Code 同样是一个极佳的选择，它结合了编辑器的灵活性和 IDE 的许多强大功能，如智能代码补全、语法高亮、调试、任务自动化和版本控制集成。

本文将详细介绍如何在 VS Code 中搭建和使用 C++ 开发环境，从基础的安装配置到复杂的项目构建和调试。

1. 为什么选择 VS Code 进行 C++ 开发？

在开始之前，我们先简要了解一下 VS Code 对 C++ 开发者的吸引力：

轻量且快速： 相比传统的重量级 IDE (如 Visual Studio 或 Eclipse CDT)，VS Code 启动更快，占用资源更少。
高度可定制： 通过安装扩展，可以轻松添加对特定功能、框架或工具链的支持。
跨平台： VS Code 支持 Windows、macOS 和 Linux，你可以在任何操作系统上使用统一的开发环境。
强大的编辑功能： 语法高亮、智能代码补全 (IntelliSense)、代码片段、多光标编辑、集成终端等。
集成调试器： 可以方便地设置断点、查看变量、单步执行代码。
任务自动化： 可以配置任务来执行编译、构建、测试等操作。
Git 集成： 内置强大的 Git 版本控制支持。
活跃的社区： 庞大的用户基础和活跃的社区意味着有大量可用的扩展和丰富的在线资源。

需要注意的是，VS Code 本身不是一个编译器或调试器。它是一个编辑器，通过扩展来调用系统上已经安装好的编译器 (如 GCC, Clang, MSVC) 和调试器 (如 GDB, LLDB, MSVC Debugger) 来进行 C++ 的编译、运行和调试。因此，在开始使用 VS Code 之前，你需要确保你的系统上已经安装了 C++ 开发工具链。

2. 前置准备：安装 C++ 开发工具链

正如前文所述，VS Code 需要依赖外部的编译器和调试器。你需要根据你使用的操作系统来安装相应的工具链。

Windows:
- MinGW-w64: 提供 GCC 和 GDB。这是一个在 Windows 上广泛使用的 C++ 工具链，可以方便地通过 MSYS2 或 TDM-GCC 安装。推荐使用 MSYS2，它提供了一个类似 Linux 的环境，可以通过包管理器轻松安装 MinGW-w64 GCC 和 GDB。
- MSVC (Visual Studio Build Tools): 如果你需要使用微软官方的编译器和调试器，可以安装 Visual Studio Community 版本 (或者只安装 Build Tools)。VS Code 的 C/C++ 扩展对 MSVC 有很好的支持。
macOS:
- Xcode Command Line Tools: 安装 Xcode 后会包含 Clang 和 LLDB，或者通过在终端运行 xcode-select --install 来单独安装命令行工具。这是 macOS 上最常用的 C++ 工具链。
Linux:
- GCC 和 GDB: 大多数 Linux 发行版默认或可以通过包管理器轻松安装 GCC 和 GDB。例如，在 Ubuntu/Debian 上使用 sudo apt update && sudo apt install build-essential gdb，在 Fedora 上使用 sudo dnf install gcc-c++ gdb。
- Clang 和 LLDB: 也可以通过包管理器安装 Clang 和 LLDB。

验证安装： 安装完成后，打开终端或命令提示符，输入 g++ --version, clang++ --version, gdb --version, lldb --version (取决于你安装了哪个)，如果能看到版本信息，说明工具链安装成功并已添加到系统 PATH 环境变量中。

3. 安装 Visual Studio Code

如果你还没有安装 VS Code，请访问 VS Code 官方网站下载并安装适合你操作系统的版本。安装过程通常非常简单，按照安装向导的提示进行即可。

4. 安装 VS Code C++ 扩展

这是在 VS Code 中进行 C++ 开发的核心步骤。打开 VS Code，点击左侧边栏的“扩展”图标 (或按 Ctrl+Shift+X)。在搜索框中输入 “C++”。

你会看到许多相关的扩展，其中最重要的、由微软官方提供的扩展是：

C/C++: 提供 C++ 的 IntelliSense (代码补全、导航、错误检查)、调试支持、代码格式化等核心功能。务必安装这个扩展。

除了官方扩展，还有一些常用的、推荐安装的扩展可以增强你的 C++ 开发体验：

C/C++ Extension Pack: 这是一个扩展包，包含了 C/C++ 官方扩展以及一些其他有用的扩展，如 CMake Tools, C++ Themes 等。可以直接安装这个包。
CMake Tools: 如果你的项目使用 CMake 作为构建系统，强烈推荐安装此扩展。它提供了对 CMake 的完整支持，包括配置、构建、测试以及与调试器的集成。
Test Explorer UI + C++ Test Adapter (如 CTest Explorer, Catch2 Test Explorer 等): 如果你在项目中编写单元测试，可以使用这些扩展在 VS Code 中发现和运行测试，并在图形界面中查看结果。
Clang-Format: 用于自动格式化 C++ 代码，可以根据预设或自定义的风格规范统一代码风格。
Clang-Tidy: 用于进行静态代码分析，帮助发现潜在的 bug 和风格问题。

安装这些扩展非常简单，只需点击扩展旁边的“安装”按钮即可。安装完成后，有时需要重启 VS Code 使其完全生效。

5. 创建并运行一个简单的 C++ 文件

为了快速入门，我们先创建一个简单的单文件 C++ 程序，并学习如何在 VS Code 中编译和运行它。

在 VS Code 中，通过 File > Open Folder... 打开一个文件夹，或者新建一个文件夹并在其中打开。这个文件夹将作为你的项目工作区。
在 VS Code 的文件浏览器中，点击“新建文件”图标，创建一个名为 main.cpp 的文件。
输入以下简单的 C++ 代码：

“`cpp

include

include

include

int main() {
std::vector msg {“Hello”, “C++”, “from”, “VS Code”, “and”, “the C++ extension!”};
```
for (const std::string& word : msg) {
    std::cout << word << " ";
}
std::cout << std::endl;

// Some basic operations to demonstrate IntelliSense
int a = 10;
int b = 20;
int sum = a + b;
std::cout << "Sum: " << sum << std::endl;

return 0;
```
}
“`
4. 你会发现当你输入代码时，C/C++ 扩展会提供语法高亮、代码补全 (IntelliSense) 和错误/警告提示。这得益于扩展对代码的解析。
编译和运行： VS Code 提供了几种方式来编译和运行代码。对于简单的单文件，最快捷的方式是使用集成终端和手动命令，或者配置“任务 (Tasks)”。
- 方法一：使用集成终端
  - 打开集成终端：View > Terminal (或使用快捷键 Ctrl+ `)。
  - 在终端中，使用你的编译器命令来编译 main.cpp。例如，使用 GCC/Clang：
    bash g++ main.cpp -o main # 或者 clang++ main.cpp -o main
  - 如果编译成功，会在当前目录下生成一个可执行文件 (main 在 Linux/macOS 上，main.exe 在 Windows 上)。
  - 运行可执行文件：
    bash ./main # Linux/macOS # 或者 .\main.exe # Windows
  - 你会在终端中看到程序的输出。
- 方法二：配置任务 (Tasks)
  - VS Code 的任务功能可以自动化构建、测试等流程。我们可以配置一个任务来编译 main.cpp。
  - 打开命令面板：View > Command Palette... (或 Ctrl+Shift+P)。
  - 输入并选择 Tasks: Configure Default Build Task。
  - 选择 Create tasks.json file from template。
  - 选择 Others。
  - VS Code 会在 .vscode 目录下创建一个 tasks.json 文件，并打开它。修改文件内容如下（以 GCC 为例）：
    
    json { "version": "2.0.0", "tasks": [ { "label": "build main.cpp", // 任务名称 "type": "shell", "command": "g++", // 编译器命令 "args": [ "main.cpp", // 要编译的文件 "-o", "main", // 输出的可执行文件名称 "-g", // 生成调试信息，方便后续调试 "-std=c++11" // 或者你需要的 C++ 标准 ], "group": { "kind": "build", "isDefault": true // 设置为默认构建任务 }, "presentation": { "reveal": "always" // 运行时显示终端 }, "detail": "Compile main.cpp with g++" } ] }
    * 保存 tasks.json 文件。
    * 现在，你可以通过 Terminal > Run Build Task (或 Ctrl+Shift+B) 来运行这个构建任务。VS Code 会执行你在 command 和 args 中指定的命令，并在集成终端中显示输出。
    * 编译成功后，你仍然需要在终端中手动运行可执行文件 (./main 或 .\main.exe)。

6. 调试 C++ 程序

VS Code 强大的调试功能是其一大亮点。我们可以利用之前生成的调试信息 (-g 编译选项) 来调试程序。

确保你已经使用 -g 选项编译了你的程序（例如，通过上面的 tasks.json 任务）。
打开要调试的源文件 (main.cpp)。
设置断点：在你希望程序暂停的地方，点击代码行号左侧的空白区域，会出现一个红点，表示成功设置了断点。例如，在 std::cout << word << " "; 这一行设置断点。
切换到“运行和调试”视图：点击左侧边栏的运行图标 (或按 Ctrl+Shift+D)。
创建调试配置：在调试视图顶部，点击齿轮图标旁边的下拉菜单，选择 Create a launch.json file。
选择环境：VS Code 会提示你选择调试环境。选择 C++ (GDB/LLDB) (如果你使用 GCC/Clang) 或 C++ (MSVC) (如果你使用 MSVC)。
VS Code 会在 .vscode 目录下创建一个 launch.json 文件，并打开它。你需要根据你的程序修改配置。以下是一个使用 GDB/LLDB 的示例配置：

json { "version": "0.2.0", "configurations": [ { "name": "Debug main", // 配置名称 "type": "cppdbg", "request": "launch", "program": "${workspaceFolder}/main", // 要调试的可执行文件路径，`${workspaceFolder}` 代表当前项目文件夹 "args": [], // 命令行参数，如果需要 "stopAtEntry": false, // 程序启动时是否在入口处暂停 "cwd": "${workspaceFolder}", // 程序工作目录 "environment": [], "externalConsole": false, // 是否使用外部控制台，true 会弹出一个新窗口 "MIMode": "gdb", // 调试模式：gdb 或 lldb (macOS/Linux) // "MIMode": "lldb", // 如果你使用 LLDB "setupCommands": [ // 调试器启动后执行的命令 { "description": "Enable pretty-printing for gdb", "text": "-enable-pretty-printing", "ignoreFailures": true } ], // Optional: if you need to build before debugging "preLaunchTask": "build main.cpp" // 在启动调试前运行的任务，这里指定运行之前配置的构建任务 } ] }
* 注意:
* program 路径需要正确指向你的可执行文件。在 Windows 上可能是 ${workspaceFolder}\\main.exe。
* MIMode 根据你的调试器选择 gdb 或 lldb。
* preLaunchTask 非常有用，它确保你在调试前程序是最新编译的版本。如果你的 tasks.json 中构建任务的 label 不同，请修改此处。
保存 launch.json 文件。
在调试视图顶部，确保下拉菜单选中了你刚刚创建的配置（例如 “Debug main”）。
点击绿色的“开始调试”按钮 (或按 F5)。

程序将开始执行，并在你设置的断点处暂停。此时，你可以：

在左侧的“变量”窗口查看当前作用域内的变量值。
在“监视”窗口添加你想持续监控的变量或表达式。
在“调用堆栈”窗口查看函数的调用链。
使用调试控制条 (通常出现在顶部或底部) 进行操作：
- 继续 (F5)：继续执行到下一个断点或程序结束。
- 单步跳过 (F10)：执行当前行，如果调用了函数则跳过函数体。
- 单步调试 (F11)：执行当前行，如果调用了函数则进入函数体。
- 单步跳出 (Shift+F11)：从当前函数中跳出。
- 重启 (Ctrl+Shift+F5)：重新启动调试会话。
- 停止 (Shift+F5)：停止调试会话。

通过调试功能，你可以逐步跟踪程序的执行流程，检查变量状态，从而更容易地发现和解决问题。

7. 使用 CMake 管理大型项目

对于实际的 C++ 项目，特别是包含多个源文件、依赖库和复杂构建配置的项目，手动编写编译器命令或 tasks.json 会变得非常繁琐。这时，使用一个构建系统是必不可少的，而 CMake 是当前 C++ 领域最流行的跨平台构建系统之一。

如果你的项目使用 CMake，VS Code 的 CMake Tools 扩展将极大地简化开发流程。

安装 CMake： 确保你的系统上已经安装了 CMake。可以从 CMake 官网下载或使用包管理器安装。验证方法是在终端输入 cmake --version。
安装 CMake Tools 扩展： 如果你之前没有安装 C++ Extension Pack 或单独安装过 CMake Tools，请现在安装它。
创建 CMake 项目： 在你的项目根目录下创建一个名为 CMakeLists.txt 的文件。这是一个 CMake 项目的核心配置文件。

例如，对于一个包含 main.cpp 和 my_library.h/my_library.cpp 的简单项目：

“`cpp
// my_library.h

ifndef MY_LIBRARY_H

define MY_LIBRARY_H

void print_message();

endif

“`

“`cpp
// my_library.cpp

include “my_library.h”

include

void print_message() {
std::cout << “Hello from my_library!” << std::endl;
}
“`

“`cpp
// main.cpp

include

include “my_library.h”

int main() {
std::cout << “Main program starts.” << std::endl;
print_message();
return 0;
}
“`

对应的 CMakeLists.txt 可能如下所示：

“`cmake

最小所需的 CMake 版本

cmake_minimum_required(VERSION 3.10)

项目名称

project(MyCppProject VERSION 1.0)

添加一个源文件组作为库（可选，这里只是为了组织）

add_library(my_library my_library.cpp my_library.h)

添加一个可执行文件

add_executable(MyCppProject main.cpp)

将库链接到可执行文件

target_link_libraries(MyCppProject my_library)

设置 C++ 标准 (例如 C++14)

target_compile_features(my_library PUBLIC cxx_std_14)
target_compile_features(MyCppProject PUBLIC cxx_std_14)

或者使用全局属性 (不推荐用于大型项目，容易混淆)

set(CMAKE_CXX_STANDARD 14)

set(CMAKE_CXX_STANDARD_REQUIRED True)

`` 4. **使用 CMake Tools 扩展：** * 打开包含CMakeLists.txt的文件夹。 * CMake Tools 扩展会自动检测到这是一个 CMake 项目，并在 VS Code 窗口的底部状态栏显示 CMake 相关的选项，例如选择构建工具链 (Kit) 和构建目标 (Build Target)。 * **配置 (Configure):** CMake Tools 会提示你配置项目。点击状态栏的“未配置”或使用命令面板 (Ctrl+Shift+P) 输入CMake: Configure。你需要选择一个工具链 (Kit)，CMake Tools 会尝试自动检测你系统上的工具链（例如 GCC, Clang, MSVC）。选择合适的工具链后，CMake 会运行，生成构建文件 (例如 Makefile 或 Visual Studio 项目文件) 在一个构建目录下 (通常是build)。 * **构建 (Build):** 配置成功后，状态栏会显示构建目标 (通常是项目名称)。点击状态栏的构建按钮或使用命令面板输入CMake: Build。CMake Tools 会调用相应的构建工具 (如 Make, Ninja, MSBuild) 来编译你的项目。构建输出会在集成终端中显示。 * **运行 (Run):** 构建成功后，点击状态栏的运行按钮或使用命令面板输入CMake: Run。CMake Tools 会运行你指定的可执行目标。 * **调试 (Debug):** CMake Tools 可以与 VS Code 的调试器深度集成。在源代码中设置断点后，点击状态栏的调试按钮或使用命令面板输入CMake: Debug。CMake Tools 会自动生成一个调试配置，并启动调试会话。这比手动编写launch.json要方便得多。你也可以通过命令面板使用CMake: Debug Target` 来选择特定的目标进行调试。

CMake Tools 扩展极大地简化了基于 CMake 的 C++ 项目的构建、运行和调试流程，是开发复杂 C++ 项目的利器。

8. 代码格式化和静态分析

保持代码风格一致性和发现潜在问题对于团队协作和代码质量至关重要。VS Code 提供了丰富的支持。

代码格式化 (Formatting): C/C++ 扩展支持 Clang-Format 或其他格式化工具。
- 首先，你需要在系统上安装 Clang-Format。
- 然后在 VS Code 的设置 (File > Preferences > Settings 或 Ctrl+,) 中搜索 “C++ Formatting”。
- 你可以选择格式化提供者 (C_Cpp.formatting.provider) 为 clang-format。
- 你可以指定 Clang-Format 的风格 (C_Cpp.formatting.clangFormatStyle)，如 LLVM, Google, Chromium, Mozilla, WebKit，或者使用 file 表示在项目根目录下的 .clang-format 文件中指定风格。
- 设置 editor.formatOnSave 为 true 可以让你在保存文件时自动格式化代码。
- 你也可以通过右键菜单选择 “Format Document” 或使用快捷键 (Shift+Alt+F) 来手动格式化当前文件。
静态分析 (Linting): C/C++ 扩展支持 Clang-Tidy。
- 首先，在系统上安装 Clang-Tidy。
- 在 VS Code 设置中搜索 “C++ Linting”。
- 设置 C_Cpp.codeAnalysis.runAutomatically 为 true 可以让你在编辑时自动运行静态分析。
- 你可以配置 C_Cpp.codeAnalysis.clangTidy.args 和 C_Cpp.codeAnalysis.clangTidy.checks 来指定 Clang-Tidy 的检查项和参数。

9. 其他有用的功能和技巧

代码片段 (Snippets): VS Code 有很多内置的代码片段，比如输入 for 然后按 Tab 会生成一个 for 循环的模板。你也可以安装扩展或自定义自己的代码片段 (File > Preferences > Configure User Snippets)。
Peek Definition / Go to Definition: 右键点击符号 (变量、函数、类等)，选择 “Peek Definition” (窥视定义) 或 “Go to Definition” (跳转到定义) 来快速查看或跳转到该符号的定义处。
Find All References: 找到所有引用某个符号的地方。
Rename Symbol: 对符号进行重命名，并同时修改所有引用处。
集成终端： 充分利用 VS Code 的集成终端 (Ctrl+ `)，你可以在其中执行任何命令行操作，如编译、运行脚本、Git 命令等，无需切换到外部终端窗口。
键盘快捷方式： 熟悉并自定义常用的键盘快捷方式 (File > Preferences > Keyboard Shortcuts 或 Ctrl+K Ctrl+S) 可以极大地提高效率。
设置同步： 登录你的 Microsoft 或 GitHub 账号，可以在不同设备之间同步你的 VS Code 设置、扩展、快捷方式等。
Source Control (Git): VS Code 对 Git 有出色的集成支持。在左侧的 Source Control 视图中，你可以方便地查看文件改动、暂存、提交、推送/拉取等操作。

10. 常见问题及故障排除

IntelliSense 不工作或不准确：
- 确保 C/C++ 扩展已安装并启用。
- 检查右下角状态栏的 C/C++ 扩展状态，看是否有错误或警告。
- 检查 VS Code 设置中的 C_Cpp.default.includePath 和 C_Cpp.default.browse.path 是否正确配置了你的头文件路径。对于 CMake 项目，CMake Tools 会自动配置这些路径。
- 尝试使用命令面板运行 C/C++: Reset IntelliSense Cache 或 Developer: Reload Window。
编译失败：
- 检查编译器是否正确安装并已添加到系统 PATH。
- 检查你的构建命令或 tasks.json/CMakeLists.txt 文件是否有语法错误或路径问题。
- 查看终端中的详细错误信息，根据错误提示进行排查。
调试无法启动或断点无效：
- 确保程序是使用调试信息 (-g 选项) 编译的。
- 检查 launch.json 文件中的 program 路径是否正确指向了可执行文件。
- 检查 MIMode 是否与你使用的调试器匹配 (gdb/lldb/msvc)。
- 确保 preLaunchTask 正确配置并在调试前成功运行，保证可执行文件是最新的。
- 对于复杂的调试场景，可能需要配置更多的调试参数。参考 VS Code 调试文档和 C/C++ 扩展文档。

总结

在 VS Code 中进行 C++ 开发是一个高效且灵活的选择。通过安装 C++ 工具链、VS Code 和 C/C++ 扩展（特别是对于大型项目推荐 CMake Tools），你可以获得强大的编辑、构建、运行和调试功能。从简单的单文件编译到复杂的 CMake 项目管理，VS Code 提供了流畅的开发体验。

本文提供了在 VS Code 中进行 C++ 开发的基础和进阶步骤。请记住，VS Code 的力量在于其可扩展性，你可以根据自己的需求和项目特点，探索并安装更多有用的扩展，进一步优化你的开发工作流程。多实践，多尝试，你将能够充分利用 VS Code 的强大功能，提升你的 C++ 开发效率。

祝你在 VS Code 中享受愉快的 C++ 编程之旅！

如何在 VS Code 中进行高效的 C++ 开发

1. 为什么选择 VS Code 进行 C++ 开发？

2. 前置准备：安装 C++ 开发工具链

3. 安装 Visual Studio Code

4. 安装 VS Code C++ 扩展

5. 创建并运行一个简单的 C++ 文件

include

include

include

6. 调试 C++ 程序

7. 使用 CMake 管理大型项目

ifndef MY_LIBRARY_H

define MY_LIBRARY_H

endif

include “my_library.h”

include

include

include “my_library.h”

最小所需的 CMake 版本

项目名称

添加一个源文件组作为库（可选，这里只是为了组织）

添加一个可执行文件

将库链接到可执行文件

设置 C++ 标准 (例如 C++14)

或者使用全局属性 (不推荐用于大型项目，容易混淆)

set(CMAKE_CXX_STANDARD 14)

set(CMAKE_CXX_STANDARD_REQUIRED True)

8. 代码格式化和静态分析

9. 其他有用的功能和技巧

10. 常见问题及故障排除

总结

发表评论 取消回复

发表评论取消回复