Linux开发：优化VSCode C++开发体验

文章目录

- 0. 引言
- 1. 配置C++头文件路径（includePath）
- 2. 提升“查找所有引用”（Find All References）功能的速度
- 3. 配置远程调试环境
- - 3.1 配置调试器
  - 3.2 定义预启动任务
  - 3.3 解释
  - 3.4 调试步骤
- 4. 使用正则表达式进行批量文本替换
- 5. 配置使用 cpplint和clang-format

0. 引言

本文将详细讲解如何通过VSCode的设置和插件优化C++开发效率，涵盖以下几个优化点：

配置头文件路径，确保代码的智能提示和跳转功能顺畅；
使用正则表达式批量处理代码中的文本；
配置远程调试，简化跨机器调试流程；
通过gtags插件提升“查找所有引用”功能的性能；
配置使用 cpplint和clang-format。

1. 配置C++头文件路径（includePath）

在大型C++项目中，配置额外的头文件路径是确保代码导航（如跳转到定义、自动补全）正常工作的关键。VSCode通过c_cpp_properties.json文件管理C/C++的项目设置，其中可以指定头文件的路径。

步骤：

打开C++配置文件
使用Ctrl + Shift + P，搜索并选择C/C++: Edit Configurations (UI)或C/C++: Edit Configurations (JSON)，进入.vscode/c_cpp_properties.json配置文件。
修改includePath字段
在c_cpp_properties.json中，定位到includePath字段，添加项目所需的头文件路径。例如：
```
{"configurations": [{"name": "Linux","includePath": ["${workspaceFolder}/**","/path/to/your/arm64/headers"],"defines": [],"compilerPath": "/path/to/aarch64-linux-gnu-g++","cStandard": "c11","cppStandard": "c++14","intelliSenseMode": "linux-gcc-arm64"}],"version": 4
}
```
说明：
- ${workspaceFolder}/**：包括当前工作区的所有子目录，VSCode将从这些路径中查找头文件。
- "/path/to/your/arm64/headers"：应替换为实际的ARM64项目头文件路径。

通过此配置，智能跳转功能将覆盖所有必要的头文件目录，避免代码提示失效的情况。

2. 提升“查找所有引用”（Find All References）功能的速度

VSCode内置的“查找所有引用”功能有时性能较差，尤其是面对大规模C++项目时。可以使用gtags插件结合GNU Global工具，极大提高这一功能的效率。

步骤：

安装gtags插件
在VSCode中搜索并安装gtags插件。相较于C/C++ GNU Global插件，gtags能提供更加高效和精确的代码索引。
安装GNU Global工具
在Ubuntu系统下使用以下命令安装GNU Global：
```
sudo apt install global
```
生成gtags索引
在C++项目根目录运行以下命令生成符号索引：
```
gtags .
```
该命令将生成GTAGS等文件，包含项目中函数、类、变量等符号的索引信息。
使用“Find All References”
通过gtags生成的索引，重新运行“查找所有引用”功能，性能和准确度都会显著提升。

详见: 解决vscode C++代码查找所有引用“Find all reference“慢的问题

3. 配置远程调试环境

在进行跨机器的远程调试时，VSCode 可以通过 gdbserver 实现对远程主机上运行的程序进行调试。以下步骤将演示如何配置 VSCode，以便连接远程机器上的 GDB 实例，并进行调试。

3.1 配置调试器

首先，需要在 launch.json 中配置远程调试器，连接远程主机上的 gdbserver。以下是一个示例配置：

{"version": "0.2.0","configurations": [{"name": "Remote Debugging (gdb)","type": "cppdbg","request": "launch","targetArchitecture": "x86_64", // 更改为目标架构"program": "${workspaceFolder}/build/test", // 要调试的可执行文件"args": ["--device-ip", "172.168.1.10", "--device-port", "8010", "--number", "10", "--output-filename", "test.txt"],"stopAtEntry": false,"cwd": "${workspaceFolder}","environment": [],"externalConsole": false,"MIMode": "gdb","miDebuggerServerAddress": "remote-host:2345", // 替换为远程主机的IP地址和端口"setupCommands": [{"description": "启用GDB Pretty Printing","text": "-enable-pretty-printing","ignoreFailures": true},{"description": "设置反汇编样式为Intel格式","text": "-gdb-set disassembly-flavor intel","ignoreFailures": true}],"preLaunchTask": "start_remote_gdb", // 启动远程gdb的任务"miDebuggerPath": "/usr/bin/gdb" // 可选，指定GDB路径}]
}

3.2 定义预启动任务

"preLaunchTask": "start_remote_gdb" 是一个关键步骤，它用于在启动调试前执行任务，比如通过 SSH 连接到远程主机并启动 gdbserver。我们需要在 VSCode 的 tasks.json 中定义这个任务。

在项目的 .vscode 目录下，创建或编辑 tasks.json，添加以下内容：

{"version": "2.0.0","tasks": [{"label": "start_remote_gdb","type": "shell","command": "ssh user@remote-host 'gdbserver :2345 /path/to/remote/executable'", "problemMatcher": [],"group": {"kind": "build","isDefault": true}}]
}

3.3 解释

miDebuggerServerAddress：指定远程 gdbserver 所在的 IP 地址和端口号。确保该端口对开发机可达。
preLaunchTask：配置了一个任务，用于在调试启动前通过 SSH 连接到远程主机，并运行 gdbserver。这会监听指定端口（如 2345），等待本地 GDB 调试器连接。
miDebuggerPath：本地 GDB 的路径。若远程调试中已经通过 gdbserver 进行控制，可以忽略此项。

3.4 调试步骤

SSH 连接启动 gdbserver：通过预启动任务，VSCode 会自动通过 SSH 连接到远程主机，并运行 gdbserver，启动远程调试服务。
本地 GDB 调试器连接：随后，VSCode 启动本地 GDB 调试器，并通过 miDebuggerServerAddress 连接到远程 gdbserver，从而实现远程调试。