需求背景
编写完成一个代码源文件，他人想查看这个文件是谁编写的？、什么时候创建的？、最后一个编辑时间？等。 如果文件所有者不写的话，你无法知道这些信息。
我想在文件快速添加自定义头部信息以及函数注释信息，提供给自己和他人查询方便。当然我们可以一个一个字符敲上去，但是这种效率不高且容易忘记。在VSCode上刚好有一个插件可以满足需求：koroFileHeader
插件安装
在VSCode应用商店下载koroFileHeader插件，重启VSCode。 接着设置注释模板配置文档：
在 setting.json 中添加如下配置信息
//自动生成注解
"fileheader.configObj": {
"createFileTime": true, //设置为true则为文件新建时候作为date，否则注释生成时间为date
"autoAdd": true, //自动生成注释
"annotationStr": {
"head": "/*",
"middle": " * @",
"end": " */",
"use": true //设置自定义注释可用
}
},
//头部注释(ctrl + win + t)
"fileheader.customMade": {
"Description": "",
"Author": "your name",
"version": "",
"Date": "Do not edit",
"LastEditors": "your name",
"LastEditTime": "Do not Edit"
},
//方法(函数)注释(ctrl + win + i)
"fileheader.cursorMode": {
"description": "",
"param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
"return": ""
},
"editor.suggestSelection": "first",
"vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue"
重启VSCode后立即生效。
新建文件会自动生成头部注释信息，支持手动快捷键添加注释信息。
- ctrl + win + t : 快速生成函数注释信息
- ctrl + win + i : 快速生成文件头部注释信息
