korofileheader插件是用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。
首先打开VScode,进入扩展商店,搜索koroFileHeader进行安装
![](https://img-blog.csdnimg.cn/img_convert/a6503d0e81004d23ac1c953bc9915e86.png)
打开设置-搜索Fileheader-点击头部注释的setting.json文件
![](https://img-blog.csdnimg.cn/img_convert/bed725e8db7f40ddb90a14a9e80fcdc9.png)
可以在其中配置头部注释
"fileheader.customMade": {
"Author": "HLei", //作者
"Date": "Do not edit", //文件生成时间
"email": "******@163.com", //邮箱
"github": "https://github.com/****", // github地址
"LastEditors": "HLei", //最后更改人
"LastEditTime": "Do not edit", // 最后编辑时间
"Description": "" // 描述
}
其中作者和邮箱可以从git中获取,动态配置
"fileheader.customMade": {
"Author": "git config user.name", //作者
// "Author": "git config user.name", // 可以获取git用户名
// "Author": "HLei", // 写死的固定值 不从git config中获取
"email": “git config user.email”, //邮箱
// "email": "git config user.email", // 可以获取git邮箱
// "email": "******@163.com", // 写死的固定值 不从git config中获取
}
设置完后,打开文件使用快捷键Ctrl+Alt+i,自动生成头部注释,效果图如下:
![](https://img-blog.csdnimg.cn/img_convert/5d5b0e6de90f4881b9fc1ee8b3102226.png)
拓展:
如果快捷键Ctrl+Alt+i失效,打开键盘快捷键方式,搜索fileheader,查看快捷键命令是不是Ctrl+Alt+i,
![](https://img-blog.csdnimg.cn/img_convert/53e6050e7b844641b4cc179513a58a41.png)
如果不是可以双击键绑定,修改自己想设置的快捷键(注意一定不要和已存的快捷键冲突)
![](https://img-blog.csdnimg.cn/img_convert/6ba0aeddb9ac440e9183d2469c03f0d6.png)
可以设置新增文件,自动添加文件头部注释,建议设置false,自己手动设置需要添加头部注释的文件更好
"fileheader.configObj": {
"autoAdd": false, // 检测文件没有头部注释,自动添加文件头部注释
},