一、安装插件
安装KoroFileHeader插件。
二、配置插件的json文件
1.搜索步骤:vscode左下角齿轮→设置→搜索框中输入“fileheader”→选中后跳转到插件json文件(settings.json)。
2.在json文件末尾添加模板。(模板内的参数可根据github上的开发者说明自行添加修改)
//*********************************************************************
// 头部注释
"fileheader.customMade": {
"Author": "HHH", // 同时获取用户名与邮箱
"Date": "Do not edit", // 文件创建时间(不变)
"LastEditTime": "Do not edit", // 文件最后编辑时间
"FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
"Description": "", // 介绍文件的作用、文件的入参、出参。
},
// 函数注释
"fileheader.cursorMode": {
"description": "", // 函数注释生成之后,光标移动到这里
"param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
"return": "",
},
//*********************************************************************
三、使用快捷键
1.文件模板注释快捷键:ctrl+win+i
2.函数模板注释快捷键:ctrl+win+t