VScode中使用代码模板

前言：平时在做项目时常常需要写大量的注释，来帮助其他人理解自己的代码结构，笔者就常常出现写注释时间和码代码时间对半开的情况，这里分享一下VScode里的模板功能

首先感受一下使用模板有多方便：

这么多的注释格式都是模板一键生成的🌌不要太爽！

要使用自定义模板，打开VScode面板的”File”->”Preference”->”User snippets”

在弹窗中选择你要自定义模板的编程语言

这边笔者选择的是C++语言模板，会自动打开一个JSON文件

啥？不知道JSON？快去学！VScode很多配置文件都是用JSON写的噢

{
	"annote for funciton":{
		"prefix": "funcAnnotation",
		"body": [
			"/**\t\t@brief\t\t函数注释",
			"  *\t\t@note\t\t注意事项",
			"  *\t\t@author\t\t江榕煜（2020.9.4）",
			"  *\t\t@param\t\tv1:参数作用",
			"  *\t\t@return\t\tretName:返回参数说明",
			" **/"
		],
		"description": "函数注释模板"
	},
	"annote for variable":{
		"prefix": "varAnnotation",
		"body": [
			"/**\t\t@brief\t\t变量注释",
			"  *\t\t@note\t\t注意事项",
			"  *\t\t@author\t\t江榕煜（2020.9.4）",
			" **/"			
		],
		"description": "变量注释模板"
	}
}

在该JSON文件中，每一个键值对就是一个模板的自定义。比如上面的第一个键值对，函数注释模板（key是”annote for funciton”），属性有：prefix（预匹配字符串），body（生成内容），description（描述）

在使用的时候，（一般）只要输入prefix的前几个字母，选择弹出的提示就可自动补齐模板了！见下图：

接下来就自动动手试试吧🎈I Love VScode！

Donate