vscode远程调试c/c++程序

一 前言

由于工作中需要在linux环境中开发C++项目，需要对linux下的c++文件进行编译和调试，因此本文介绍一种通过vscode远程开发linux下的c++代码用到的编译和调试方式。

开发环境：

客户机（vscode安装机器）：windows 10
所需的vscode插件：c/c++
开发机：（c++程序运行机器）：centos7
开发机所需环境：g++，gdb

前置条件

1、满足上述开发环境。
如果不满足，可以参考以下资料：
安装vscode
centos7 安装g++,gdb 这里推荐安装 8.X版本，一般cetos都预装了gcc4.8.2，但是为了编译效率，强烈建议安装gcc8编译套件
2、已经可以使用vscode连接到linux系统进行远程开发
可以参考以下文章进行配置：2019 VS Code 远程开发配置（热乎的）

二 实现方式

1 编写测试代码

在vscode新建目录，编写简单测试程序，本文给出一个简单的测试demo：

// main.cpp
#include <stdlib.h>
#include <iostream>
using namespace std;

int main(void) {
  int count = 10;
  for (size_t i = 0; i < count; i++)
  {
    cout << i << endl;
  }
  return 0;
}

2 配置vscode的task

新建一个任务，执行编译任务：
（1）按住ctrl+shift+P，打开命令面板；
（2）选择Configure Tasks…，选择Create tasks.json file from templates，之后会看到一系列task模板；
（3）选择others，创建一个task，下面是一个task的示例：

{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            "label": "echo",
            "type": "shell",
            "command": "g++",
            "args":[
                "-g", // 必须的参数，指定编译时需要使用gdb调试，否则会出现无法加入断点的问题
                "main.cpp",
                "-o",
                "main.out"
            ]
        }
    ]
}

该任务相当于在执行编译命令g++ -g main.cpp -o main.out

3 配置debug信息

vscode的debug配置信息由.vscode目录下的launch.json文件管理，因此需要配置debug文件信息。
（1）点击侧边栏的debug按钮，就是那只虫子图标；
（2）在上面的debug栏目里，点击齿轮图标；
（3）在下拉菜单中选择 C++ (GDB/LLDB)，这时会在.vscode文件夹下创建一个launch.json文件，用来配置debug；下面是launch.json文件的一个示例：

{
    // 使用 IntelliSense 了解相关属性。 
    // 悬停以查看现有属性的描述。
    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "(gdb) 启动", //会显示在debug界面的debug名称
            "type": "cppdbg", //指定debug的类型
            "request": "launch",
            "program": "${workspaceFolder}/main.out", // 对应编译生成的可执行文件
            "args": [], // 可执行文件带有的参数，根据可执行文件需要填写
            "stopAtEntry": false,
            "cwd": "${workspaceFolder}", // gdb程序的工作目录
            "environment": [],
            "externalConsole": false,
            "MIMode": "gdb", // debug 使用的程序
            "setupCommands": [
                {
                    "description": "为 gdb 启用整齐打印",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": true
                }
            ],
            "preLaunchTask": "echo" // 该项的值对应任务文件中的label的值，表示在执行debug前先执行编译任务
        }
    ]
}

配置完成保存文件后，就可以看到在vscode的debug界面有一个名为(gdb) 启动的debug按钮了。

4 运行

可以在1中编写的cpp文件中设置断点，在需要设置断点行的左侧点击出现红点即可。
然后按F5或者点击debug界面的运行按钮，即可启动debug程序，并使程序在断点处停下来。

三 参考资料

linux系统下如何在vscode中调试C++代码