VSCODE（七）创建C++编译任务

任务是与工作区相关的，可用于运行程序和脚本，这次我们来看看C++编译任务是如何编写的。

一、任务是如何帮助我们完成C/C++开发的？

C/C++开发需要：

• 一些辅助编辑、校验的功能
• 代码的编译
• 打包
• 测试
• 部署

对于第一项，C/C++开发时都会下载C/C++插件，帮助我们完成编辑、编译、调试功能。智能感知、调试和代码浏览(Go to definition、Find All Reference)。我们知道task借助终端可执行一切终端任务，我们程序进行“编译、打包、测试和部署”也是通过终端完成，所以vscode完全可以进行C++开发。对于C/C++而言，编译由g++、gdb完成，编译打包测试部署由Makefile和CMake等自动化编译工具完成。

二、配置默认编译任务？

假设我们要编译的源文件如下：

#include <iostream>
int main()
{
    std::cout<<"Hello world"<<std::endl;

    return 0;
}

按F1选择Tasks:Configure Default Build Task，字面意思是任务：配置一个默认编译任务。
接着会继续提示你选择默认编译任务，根据你编译的源文件类型选择合适的编译器，由于我是C++程序，因此我们选择compiler:/usr/bin/g++这一栏：
接着VSCODE自动帮你在.vocode下新建一个tasks.json（注意这里task用了复数，也就是这个文件可以执行多个任务），其内容如下：

{
	"version": "2.0.0",
	"tasks": [
		{
			"type": "cppbuild",
			"label": "C/C++: g++ build active file",
			"command": "/bin/g++",
			"args": [
				"-fdiagnostics-color=always",
				"-g",
				"${file}",
				"-o",
				"${fileDirname}/${fileBasenameNoExtension}"
			],
			"options": {
				"cwd": "${fileDirname}"
			},
			"problemMatcher": [
				"$gcc"
			],
			"group": {
				"kind": "build",
				"isDefault": true
			},
			"detail": "compiler: /bin/g++"
		}
	]
}

至此，任务配置已经完成，点击你要编译的源文件为，按下ctrl+shift+b即可运行编译任务，这个默认任务是编译一个当前正在编辑的源文件，目标程序名称是源文件去掉后缀。

看懂这些JSON文件并不困难，这里说一下一些比较重要的配置键值对：

• "version" : "2.0.0" 这个tasks.json版本号是2.0.0
• tasks 内容（中括号里面的，数据类型：数组）

tasks内容任务数组，不同任务使用不同逗号隔开。如下：

tasks:[
	{
		任务一
	}，
	{
		任务二
	}
]

这里只用了只有一个任务：

• type 一般是shell或者process。对于C++程序cppbuild等于shell的别名，为了更加可读？
• label 任务标签，用于识别不同的任务
• command 终端中执行的命令，这里是g++编译器
• args 数组 表示g++选项，如果忘记了回去复习一下g++内容
• options 额外选项。这里的选项是"cwd"，当前脚本或者程序执行的地方，如果不给定默认是工作空间的根目录。
• problemMatcher 不清楚是干啥的
• group 说明这个任务归属，有两个组，一个是test组，另一个是build组。还可以配置是否是该组的默认任务
• detail 详细说明

我们知道在.vscode中的配置是可以移植的，如果你想让你的配置更加通用，最好使用一些VSCODE预定义的一些变量，见附录（二）。

切换到需要编译的源文件并按下ctrl+shift+b，即可编译。

三、定制化编译任务

编译如下结构的cpp程序，应该如何书写tasks.json?

.
├── include
│   ├── add.h
│   └── minus.h
├── main
├── main.cpp
└── src
    ├── add.cpp
    └── minus.cpp

2 directories, 6 files

工程主要由一个mian.cpp和两个分属不同文件夹的源文件和头文件，显然不能直接套用默认模板。使用以下tasks.json内容即可进行编译：

{
	"version": "2.0.0",
	"tasks": [
		{
			"type": "cppbuild",
			"label": "C/C++: g++ build active file",
			"command": "/bin/g++",
			"args": [
				"-fdiagnostics-color=always",
				"-g",
				"${workspaceFolder}/src/*.cpp",
				"${workspaceFolder}/*cpp",
				"-o",
				"${fileDirname}/${fileBasenameNoExtension}"
			],
			"options": {
				"cwd": "${fileDirname}"
			},
			"problemMatcher": [
				"$gcc"
			],
			"group": {
				"kind": "build",
				"isDefault": true
			},
			"detail": "compiler: /bin/g++"
		}
	]
}

---

附录1：

名字	值
label	The task’s label used in the user interface.
type	The task’s type. For a custom task, this can either be shell or process. If shell is specified, the command is interpreted as a shell command (for example
command	The actual command to execute.
windows	Any Windows specific properties. Will be used instead of the default properties when the command is executed on the Windows operating system.
group	Defines to which group the task belongs. In the example, it belongs to the test group. Tasks that belong to the test group can be executed by running Run Test Task from the Command Palette.
presentation	Defines how the task output is handled in the user interface. In this example, the Integrated Terminal showing the output is always revealed and a new terminal is created on every task run.
options	Override the defaults for cwd (current working directory), env (environment variables), or shell (default shell). Options can be set per task but also globally or per platform. Environment variables configured here can only be referenced from within your task script or process and will not be resolved if they are part of your args, command, or other task attributes.
runOptions	Defines when and how a task is run.

附录（二）

名字	值
${workspaceFolder}	the path of the folder opened in VS Code
${workspaceFolderBasename}	the name of the folder opened in VS Code without any slashes (/)
${file}	the current opened file
${fileWorkspaceFolder}	the current opened file’s workspace folder
${relativeFile}	the current opened file relative to workspaceFolder
${relativeFileDirname}	the current opened file’s dirname relative to workspaceFolder
${fileBasename}	the current opened file’s basename
${fileBasenameNoExtension}	the current opened file’s basename with no file extension
${fileDirname}	the current opened file’s dirname
${fileExtname}	the current opened file’s extension
${cwd}	the task runner’s current working directory on startup
${lineNumber}	the current selected line number in the active file
${selectedText}	the current selected text in the active file
${execPath}	the path to the running VS Code executable
${defaultBuildTask}	the name of the default build task
${pathSeparator}	the character used by the operating system to separate components in file paths

---

[1] https://code.visualstudio.com/docs/editor/tasks
[2] https://www.zhihu.com/question/25636060
[3] https://www.w3school.com.cn/json/json_syntax.asp
[4] https://code.visualstudio.com/docs/editor/variables-reference