windows VSCode 远程开发配置参考

Posted 2022-11-29 资质平庸的程序员

windows VSCode 远程开发配置参考

1 VSCode的下载与安装

官网下载并安装VSCode。

2 基础插件安装

通过快捷键 “Ctrl + Shift + X” 或点击左列的扩展图标（由四个小方块组成）打开插件安装窗口栏，在搜索栏中搜索并安装以下插件
[1] Remote Development
[2] Remote-SSH

按照开发需求可选择安装
[3] Chinese (Simplified) Language Pack for Visual Studio Code

插件安装后，点击插件“需要重启加载”的提示按钮（若有）重启VSCode加载该插件。

3 无密远程登陆配置

[1] 打开 windows cmd 执行

> ssh-keygen

一路回车（id_rsa 和 id_rsa.pub将会在默认路径下生成，如C:\\Users\\winuser.ssh\\）。

[2] 选择 VSCode “远程资源管理器图标(像PC图标) >> Configure(设置的图标) >> C:\\Users\\winuser.ssh\\config”，填写以下字段并保存

Host                server_name                     /* name your remote server */
    HostName        xxx.xxx.xxx.xxx                 /* remote server ip */
    User            user                            /* user of ssh login */
    IdentityFile    C:\\Users\\winuser\\.ssh\\id_rsa    /* rsa path */

[3] 拷贝(追加) C:\\Users\\winuser.ssh\\id_rsa.pub 的内容到远程服务器的 ~/user/.ssh/authorized_keys 中

[4] 远程资源管理器 >> server_name（上一步在config中配置的Host将会显示在远程资源管理器的窗口中) >> Connect to Host in New Window

新启 VSCode 将连接到[2]中所配置的远程服务器上。此时可打开在远程服务器上的目标工程目录，随即浏览、编辑其中的源码文件。

4 远程服务器上的插件安装

登录远程服务器后，可在远程服务器上安装所需插件（安装方法同2），如
[1] C++ Intellisense（符号跳转）
[2] Git Blame（代码片段提交信息提示）
[3] …

5 远程编译&&调试配置

5.1 编译配置

通过 “Ctrl + Shift + P >> 输入 Configure Default Build Task” 打开 task.json，配置

/* ... */
    "command": "$workspaceFolder/tools/build.sh", /* 管理工程的脚本 */
    "args": [],                                     /* command 的参数 */
    "cwd": "$workspaceFolder/tools/",             /* command 的目录 */
/* ... */

5.2 调试配置

通过 “Ctrl + Shift + D >> 打开 launch.json” 或 “Ctrl + Shift + P >> 输入 Open launch.json” 打开 launch.json，配置

/* ... */

    "name": "p_debug",                      /* 被VSCode显示在调试窗口栏的左上角列表中，供调试时选择 */
    "program": "$workspaceFolder/bin/p",  /* 欲调试可执行程序 */
    "args": [],                             /* 可执行程序命令行参数*/
    "cwd":  "$workspaceFolder/bin",       /* 可执行程序的目录 */
    "miDebuggerPath": "/usr/bin/gdb"        /* gdb 在远程服务器上的路径 */
    
/* ... */

配置完成后，Ctrl + Shift + D 或选择 VSCode 左侧栏的运行图标（瓢虫+三角 图形）时，VSCode 将调试相关界面显示在左边。变量运行时值、调用堆栈等被 VSCode 默认可视化在窗口左边一栏；进入调试后，单步调试、单步跳过、继续、停止等与GDB命令相对应的操作被 VSCode 默认可视化在窗口上方。