1.搜索插件 koroFileHeader,安装;
2.安装之后打开设置,找到 设置 > 文本编辑器 > 文件 > setting.json,打开该插件设置;
3.复制粘贴下面代码到插件设置里面,保存即可生效;
"fileheader.configObj": {
"autoAdd": false,
},
"fileheader.cursorMode": {
"description": "",
"param": "",
"return": ""
},
"fileheader.customMade": {
"description": "",
"author": "yanzihao",
"github": "此处 写git项目地址",
"lastEditors": "yanzihao"
"Date": "Do not edit",
"LastEditTime": "Do not edit",
"Copyright": "此处写项目版本号"
}
4.修改 fileheader.customMade.author,fileheader.customMade.lastEditors 为自己的英文名称小写;
5.在任意文件内使用 ctrl + alt + i 生成文档注释,在类和函数上面使用 ctrl+cmd+t 生成对应的注释;
6.description:需要填写描述文件的内容,每次大改的时候需要添加上修改的内容,日期;
7.lastEditors:依次写入最后编辑者,例如 yanzihao,zhangnan, qixinxin,这样的形式。