VS Code(Cursor)远程开发调试教程(超详细)

前言 📢

声明：本文配置及开发方法同样适合Cursor ！！

在开始之前，你需要准备以下东西：

本地电脑：
- 安装好 VS Code（Windows、Mac 或 Linux 都可以）。
- 官网下载，按提示安装即可。
远程电脑（如服务器）：
- 你需要知道它的 IP 地址、用户名和密码（或者 SSH 密钥）。
- 远程电脑必须安装 SSH 服务和 C/C++ 编译器（比如 GCC 或 Clang）。
网络：
- 本地电脑和远程电脑要能互相访问，比如在同一局域网，或者远程电脑有公网 IP。

准备好了吗？我们开始吧！🚀

第一步：安装 VS Code 和必要插件 🌐

安装 VS Code
- 如果还没安装，去官网下载并安装。安装完成后，打开 VS Code，你会看到一个简洁的代码编辑器界面。
安装 Remote - SSH 插件
- 在 VS Code 左侧点击“扩展”图标（像四个小方块拼成的形状）。
- 在搜索框输入 Remote - SSH，找到微软官方的插件，点击“安装”。
- 安装完成后，窗口左下角会多一个小图标（像个显示器）。
安装 C/C++ 扩展
- 在“扩展”搜索框输入 C++，找到微软的 C/C++ 扩展，点击“安装”。
- 这个扩展提供 C/C++ 的语法高亮、智能提示和调试支持。

第二步：连接到远程电脑 💻

打开 SSH 面板
- 点击左下角的“显示器”小图标，（点击＋号）选择“Connect to Host”。
- 如果是第一次使用，会提示你配置 SSH，点击“Configure SSH”。
编辑 SSH 配置文件
- VS Code 会打开一个配置文件（通常位于 ~/.ssh/config）。
- 输入以下内容（根据你的远程电脑信息修改）：
```
Host my-serverHostName 172.168.3.127  # 远程电脑的 IP 地址User your-username      # 远程电脑的用户名Port 22                 # 默认 SSH 端口，通常不用改
```
- 保存文件后，返回 SSH 面板，选择“my-server”进行连接。
输入密码或使用 SSH 密钥
- 连接时会提示输入密码，正确输入后即可连上。
- 如果有 SSH 密钥（更安全），提前将公钥添加到远程电脑的 ~/.ssh/authorized_keys 文件中，可免输密码。
- 连接成功后，VS Code 会在远程电脑安装一些必要组件，稍等片刻即可完成。
确认连接成功
- 左下角显示“SSH: my-server”，说明你已成功连接到远程电脑！

第三步：在远程电脑上编写 C/C++ 代码 📝

打开远程文件夹
- 点击菜单“文件” > “打开文件夹”，选择远程电脑上的某个目录（例如 /home/your-username/projects）。
- 现在你操作的文件都在远程电脑上，修改也会直接保存到远程。

写一个简单的 C++ 程序

新建文件 test.cpp，输入以下代码：

#include <iostream>
int main() {std::cout << "Hello from remote!" << std::endl;return 0;
}

保存文件。

第四步：编译 C/C++ 程序 🔧

打开远程终端
- 点击菜单“终端” > “新终端”（或者ctrl+J），会打开一个远程电脑的终端。
编译代码
- 在终端输入命令进入代码目录，例如：
```
cd /home/your-username/projects
```
- 编译程序：
```
g++ test.cpp -o test
```
  （如果用 Clang，则输入 clang++ test.cpp -o test）。
- 如果提示找不到编译器，需要在远程电脑安装，例如：
```
sudo apt install g++
```
运行程序
- 编译成功后，输入：
```
./test
```
- 输出 Hello from remote!，说明程序运行正常。

第五步：调试 C/C++ 程序 ☕️

配置调试环境
- 点击左侧“调试”图标（像播放键加小虫子）。
- 点击“创建 launch.json 文件”，选择“C++: (GDB/LLDB)”。
- VS Code 会生成一个 launch.json 文件。

修改 launch.json

将 "program" 修改为你的可执行文件路径，例如：
```
"program": "/home/your-username/projects/test"
```

确保 "miDebuggerPath" 是远程电脑上 GDB 的路径，通常是 "/usr/bin/gdb"。

{// 使用 IntelliSense 了解相关属性。 // 悬停以查看现有属性的描述。// 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387"version": "0.2.0","configurations": [{"name": "(gdb) 启动", //配置名称，显示在配置下拉菜单中"type": "cppdbg",    //配置类型"request": "launch", //请求配置类型，通常是启动调试(launch)或者是附加(attach)"program": "${workspaceFolder}/projects/test", //可执行程序文件的完整路径，${workspaceFolder}表示远程连接的初始路径"args": [], //传递给程序的命令行参数"stopAtEntry": false, //可选参数，如果为true,调试程序应该在入口(main)处停止"cwd": "${workspaceFolder}/projects", //目标的工作目录"environment": [], //表示要预设的环境变量"externalConsole": false, //如果为true，则为调试对象启动控制台"MIMode": "gdb", //调试器模式/类型"setupCommands": [ //为了安装基础调试程序而执行的一个或多个GDB/LLDB命令{"description": "为 gdb 启用整齐打印","text": "-enable-pretty-printing","ignoreFailures": true}]}]
}

设置断点
- 在 test.cpp 中 std::cout 那行左侧点击，会出现一个红点，表示断点已设置。
开始调试
- 按 F5（或点击绿色播放键）启动调试，程序会在断点处暂停。
- 使用顶部工具栏的按钮（暂停、继续、停止）控制程序，还可以查看变量的值。
- 或者按 F10（单步跳过）、F11（单步调试）、shift + F11（单步跳出）、ctrl + shift + F5（重启调试）、shift + F5（停止调试）。

常见问题及解决方法 ❓

无法连接远程电脑？
- 检查 IP 地址、用户名和密码是否正确。
- 在本地命令行测试 ssh your-username@172.168.3.127，确认是否能连上。
调试时提示“找不到 GDB”？
- 在远程终端输入 gdb --version 检查是否安装。
- 未安装则运行 sudo apt install gdb 安装。
编译报错？
- 检查代码是否有语法错误。
- 确保远程电脑已安装 C/C++ 编译器。
如何关闭远程终端？
- 方法一：按 Ctrl+Shift+P，输入“关闭远程连接”。
- 方法二：点击左下角的“SSH: my-server”，选择“关闭远程连接”。
VS Code布局
聪明的你，可能已经发现文中的图片有两种布局（系统默认在左侧，而我喜欢放在右侧）。具体操作如下：
- VS Code 编辑器中按快捷键 Cmd/ctrl+shift+P 打开弹框。
- 弹框输入 setting 找到 vscode setting 打开。
- 设置面板搜索 workbench.activityBar.orientation 修改活动栏排列方向。
- 设置面板搜索 workbench.sideBar.location 修改主边栏和活动栏展示在工作台左侧或右侧。