VSCode下C++编译环境的配置

VSCode下C++编译环境的配置

以下是我在配置过程中参考的博客/文章，受益很多，其中大部分内容都差不多，我只是整理了一下：
在VS code上配置C/C++环境,exe路径问题 - thisis.wr
Visual Studio Code 如何编写运行 C、C++ 程序？ - 谭九鼎的回答 - 知乎
[VSCode插件推荐] Code Runner: 代码一键运行，支持超过40种语言 - 韩骏的文章

第一步：编译器的下载与安装

下载和安装步骤不在过多赘述，安装完后将安装目录下的bin文件夹添加到
环境变量中的PATH里去，然后需要验证编译器是否安装成功。
接下来以mingw为例演示如何进行验证：

按Win+R，运行cmd，输入gcc ,提示应该会如下图所示

输入gcc -v，提示应该如下图所示

第二步：安装扩展

• C/C++：又名cpptools，提供Debug和Format功能
• Code Runner：编译运行文件，但是没有Debug功能

第三步：配置json文件

1. 创建一个打算用来存放C++代码的工作区文件夹，路径下不能有中文和引号，最好也不要有空格
2. 使用vscode打开创建的文件夹，然后在该文件夹下新建.vscode文件夹，然后创建launch.json，tasks.json，settings.json到.vscode文件夹下，如图：
   
3. 配置刚刚创建的json文件：

launch.json

{
"version": "0.2.0",
"configurations": [{
"name": "(gdb) Launch", // 配置名称，将会在启动配置的下拉菜单中显示
"type": "cppdbg", // 配置类型，cppdbg对应cpptools提供的调试功能；可以认为此处只能是cppdbg
"request": "launch", // 请求配置类型，可以为launch（启动）或attach（附加）
"program": "${workspaceFolder}/exe/${fileBasenameNoExtension}.exe", // 将要进行调试的程序的路径
"args": [], // 程序调试时传递给程序的命令行参数，一般设为空即可
"stopAtEntry": false, // 设为true时程序将暂停在程序入口处，相当于在main上打断点
"cwd": "${workspaceFolder}", // 调试程序时的工作目录，此为工作区文件夹；改成${fileDirname}可变为文件所在目录
"environment": [], // 环境变量
"externalConsole": false, // 为true时使用单独的cmd窗口，与其它IDE一致；18年10月后设为false可调用VSC内置终端
"internalConsoleOptions": "neverOpen", // 如果不设为neverOpen，调试时会跳到“调试控制台”选项卡，你应该不需要对gdb手动输命令吧？
"MIMode": "gdb", // 指定连接的调试器，可以为gdb或lldb。但我没试过lldb
"miDebuggerPath": "gdb.exe", // 调试器路径，根据自己编译器所在位置进行设置，Windows下后缀不能省略，Linux下则不要
"setupCommands": [
{ // 模板自带，好像可以更好地显示STL容器的内容，具体作用自行Google
"description": "Enable pretty-printing for gdb",
"text": "-enable-pretty-printing",
"ignoreFailures": false
}
],
"preLaunchTask": "Compile" // 调试会话开始前执行的任务，一般为编译程序。与tasks.json的label相对应
}]
}

tasks.json

{
"version": "2.0.0",
"tasks": [{
"label": "Compile", // 任务名称，与launch.json的preLaunchTask相对应
"command": "g++",   // 要使用的编译器，C++用g++
"args": [
"${file}",
"-o",    // 指定输出文件名，不加该参数则默认输出a.exe，Linux下默认a.out
"${workspaceFolder}/exe/${fileBasenameNoExtension}.exe",
"-g",    // 生成和调试有关的信息
"-Wall", // 开启额外警告
"-static-libgcc",     // 静态链接libgcc，一般都会加上
"-fexec-charset=GBK", // 生成的程序使用GBK编码，不加这一条会导致Win下输出中文乱码
// "-std=c11", // C++最新标准为c++17，或根据自己的需要进行修改
], // 编译的命令，其实相当于VSC帮你在终端中输了这些东西
"type": "process", // process是vsc把预定义变量和转义解析后直接全部传给command；shell相当于先打开shell再输入命令，所以args还会经过shell再解析一遍
"group": {
"kind": "build",
"isDefault": true // 不为true时ctrl shift B就要手动选择了
},
"presentation": {
"echo": true,
"reveal": "always", // 执行任务时是否跳转到终端面板，可以为always，silent，never。具体参见VSC的文档
"focus": false,     // 设为true后可以使执行task时焦点聚集在终端，但对编译C/C++来说，设为true没有意义
"panel": "shared"   // 不同的文件的编译信息共享一个终端面板
},
// "problemMatcher":"$gcc" // 此选项可以捕捉编译时终端里的报错信息；但因为有Lint，再开这个可能有双重报错
}]
}

其中，参数

${workspaceFolder}/exe/${fileBasenameNoExtension}.exe

的作用是指定输出文件的位置，我在这边把所有生成的exe文件都集中指定到了工作区文件夹下的exe文件夹中，这样整个存放代码的文件夹就不会显得特别的乱，其中的${workspaceFloder}是vscode中的预定义变量

下面给出一些vscode中的预定义变量的含义：

$ {workspaceFolder} //在VS Code中打开的文件夹的路径
$ {workspaceFolderBasename} //VS代码中打开的文件夹的名称，没有任何斜杠（/）
$ {file} //当前打开的文件
$ {relativeFile} //当前打开的文件相对于workspaceFolder
$ {fileBasename} //当前打开文件的基本名称
$ {fileBasenameNoExtension} //当前打开文件的基本名称，没有文件扩展名
$ {fileDirname} //当前打开文件的目录名
$ {fileExtname} //当前打开文件的扩展名
$ {cwd} //任务运行器在启动时的当前工作目录
$ {lineNumber} //活动文件中当前选定的行号
$ {selectedText} //活动文件中当前选定的文本
$ {env:PATH} //系统中的环境变量

settings.json

该文件可以对当前工作区下的编辑器进行一些设置

{
 "files.defaultLanguage": "cpp", // ctrl+N新建文件后默认的语言
 "editor.formatOnType": true,  // 输入分号(C/C++的语句结束标识)后自动格式化当前这一行的代码
 "editor.suggest.snippetsPreventQuickSuggestions": false, // clangd的snippets有很多的跳转点，不用这个就必须手动触发Intellisense了
 "editor.acceptSuggestionOnEnter": "on", // 我个人的习惯，按回车时一定是真正的换行，只有tab才会接受Intellisense
 // "editor.snippetSuggestions": "top", // （可选）snippets显示在补全列表顶端，默认是inline

 "code-runner.runInTerminal": true, // 设置成false会在“输出”中输出，无法输入
 "code-runner.executorMap": {
     "c": "cd $dir && gcc '$fileName' -o '$workspaceRoot/exe/$fileNameWithoutExt.exe' -Wall -g -O2 -static-libgcc -std=c11 -fexec-charset=GBK && &'$workspaceRoot/exe/$fileNameWithoutExt'",
     "cpp": "cd $dir && g++ '$fileName' -o '$workspaceRoot/exe/$fileNameWithoutExt.exe' -Wall -g -O2 -static-libgcc -std=c++17 -fexec-charset=GBK && &'$workspaceRoot/exe/$fileNameWithoutExt'"
     // "c": "cd $dir && gcc $fileName -o $fileNameWithoutExt.exe -Wall -g -O2 -static-libgcc -std=c11 -fexec-charset=GBK && $dir$fileNameWithoutExt",
     // "cpp": "cd $dir && g++ $fileName -o $fileNameWithoutExt.exe -Wall -g -O2 -static-libgcc -std=c++17 -fexec-charset=GBK && $dir$fileNameWithoutExt"
 }, // 右键run code时运行的命令；未注释的仅适用于PowerShell（Win10默认），文件名中有空格也可以编译运行；注释掉的适用于cmd（win7默认），PS和bash也能用，但文件名中有空格时无法运行
 "code-runner.saveFileBeforeRun": true, // run code前保存
 "code-runner.preserveFocus": true,     // 若为false，run code后光标会聚焦到终端上。如果需要频繁输入数据可设为false
 "code-runner.clearPreviousOutput": false, // 每次run code前清空属于code runner的终端消息，默认false
 "code-runner.ignoreSelection": true,   // 默认为false，效果是鼠标选中一块代码后可以单独执行，但C是编译型语言，不适合这样用

 "C_Cpp.clang_format_sortIncludes": true, // 格式化时调整include的顺序（按字母排序）
}

可以注意到，该文件对Code Runner的运行做了一些设置，与启用调试命令时的设置一样，我把Code Runner的输出文件同样指向了工作区文件夹下的exe文件夹中，如果要自己设置其他的路径，该插件的作者向我们提供了如下变量：

$ workspaceRoot //在VS Code中打开的文件夹的路径
$ dir //正在运行的代码文件的目录
$ dirWithoutTrailingSlash //运行的代码文件目录不带斜杠
$ fullFileName //正在运行的代码文件的全名
$ fileName //正在运行的代码文件的基本名称，即没有目录的文件
$ fileNameWithoutExt //代码文件的基本名称，不带扩展名
$ driveLetter //正在运行的代码文件的驱动器号（仅Windows）
$ pythonPath //Python解释器的路径（由Python: Select Interpreter命令设置）