VS Code C++ 项目快速配置模板

两个月前我写过一篇博客 Windows VS Code 配置 C/C++ 开发环境 ，主要介绍了在 VS Code 里跑简单 C 程序的一些方法。不过那篇文章里介绍的方法仅适用于单文件程序，所以稍微大一点的项目就力不从心了。

但是对于课程设计这类，说大不大说小也不算小的 C++ 项目，也不是特别想用大型 IDE（如VS）……所以我更新了一下相关的 VSC 配置，使其也能用于多文件的 C++ 项目。

为了方便以后复用，也给其他有类似需求的人一个参考，相关的配置文件整理如下（新建项目时复制一份到 .vscode 里就行了）。

这一年来 VS Code 的 C/C++ 扩展 更新了不少，还支持在 WSL 里 Remote 开发了。不过本文中还是继续以 Windows 下的 MinGW-w64 为例。WSL 的配置也差不多，有兴趣的可以看看参考链接里的官方文档。

c_cpp_properties.json：

{
    "configurations": [
        {
            // 配置的名称，可以添加多个在编辑器右下角切换
            "name": "MinGW",
            "intelliSenseMode": "gcc-x64",
            // 这里的编译器路径，包括下面的一些选项都只是
            // 给 IntelliSense 用的，和具体项目构建没关系
            "compilerPath": "C:\\Portable\\mingw64\\bin\\gcc.exe",
            "includePath": [
                "${workspaceFolder}/**"
            ],
            "defines": [],
            "cStandard": "c11",
            "cppStandard": "c++17"
        }
    ],
    "version": 4
}

tasks.json：

{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            // 任务标签名
            "label": "compile",
            // 任务类型
            "type": "shell",
            // 编译器选择
            "command": "g++",
            // 编译预执行的命令集
            "args": [
                "-g",
                "\"${file}\"",
                "-o",
                "\"${fileDirname}\\${fileBasenameNoExtension}\""
            ],
            // 任务输出配置
            "presentation": {
                "reveal": "always",
                "panel": "shared",
                "focus": false,
                "echo": true
            },
            // 任务所属组名
            "group": "build",
            // 编译问题输出匹配配置
            "problemMatcher": {
                "owner": "cpp",
                "fileLocation": "absolute",
                "pattern": {
                    "regexp": "^(.*):(\\d+):(\\d+):\\s+(error):\\s+(.*)$",
                    "file": 1,
                    "line": 2,
                    "column": 3,
                    "severity": 4,
                    "message": 5
                }
            }
        },
        {
            "type": "shell",
            "label": "C/C++: g++.exe build active file",
            "command": "C:\\Portable\\mingw64\\bin\\g++.exe",
            "args": [
                "-g",
                "${file}",
                "-o",
                "${fileDirname}\\${fileBasenameNoExtension}.exe"
            ],
            "options": {
                "cwd": "${workspaceFolder}"
            },
            "problemMatcher": [
                "$gcc"
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            }
        }
    ]
}

launch.json：

{
    "version": "0.2.0",
    "configurations": [
        {
            // 使用 GDB 调试程序
            "name": "(gdb) Launch",
            "type": "cppdbg",
            "request": "launch",
            // 之前编译好的可执行文件路径
            "program": "${workspaceFolder}/build/${workspaceFolderBasename}.exe",
            "args": [],
            "stopAtEntry": false,
            // 设置 cwd 到 build 目录
            "cwd": "${workspaceFolder}/build",
            "environment": [],
            // 不要在集成终端里运行程序
            "externalConsole": true,
            "MIMode": "gdb",
            // 调试器可执行文件的路径
            "miDebuggerPath": "C:\\Portable\\mingw64\\bin\\gdb.exe",
            "setupCommands": [
                {
                    "description": "Enable pretty-printing for gdb",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": true
                }
            ],
            // 调试前先运行 compile（定义在上面的 tasks.json 里）
            "preLaunchTask": "compile"
        }
    ]
}

稍微解释一下这些文件的作用。

这三个文件都是放在项目的 .vscode 目录下的，其中 c_cpp_properties.json 用于配置 VSC 的 C/C++ 扩展，tasks.json 配置项目的构建流程，launch.json 则是配置如何运行（或调试）构建好的程序。

在 VSC 内编辑这些配置文件时，鼠标移动到 JSON 的 key 上就可以查看相关配置项的说明，非常方便。另外 c_cpp_properties.json 这个文件，也可以通过 Ctrl + Shift + P 面板运行 C/C++: Edit Configurations (UI) 命令打开图形化配置页面。关键配置项的作用都已经在上面的注释里说明了，就不再赘述。

最终整个项目的目录结构应该是这样的：

$ tree -a
.
├── .vscode
│   ├── c_cpp_properties.json
│   ├── launch.json
│   ├── settings.json
│   └── tasks.json
├── build
│   └── vscode-cpp-quick-setup.exe
└── src
    ├── Greeter.cpp
    ├── Greeter.h
    └── main.cpp

所有源代码放在 src 目录中，编译后的可执行文件将以当前 workspace 命名（一般是目录名），存放于 build 目录中。