在VScode中,文件自动添加头部注释-插件koroFileHeader配置

korofileheader插件是用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。

  1. 首先打开VScode,进入扩展商店,搜索koroFileHeader进行安装

  1. 打开设置-搜索Fileheader-点击头部注释的setting.json文件

  1. 可以在其中配置头部注释

  "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中获取
  }
  1. 设置完后,打开文件使用快捷键Ctrl+Alt+i,自动生成头部注释,效果图如下:

拓展:

  1. 如果快捷键Ctrl+Alt+i失效,打开键盘快捷键方式,搜索fileheader,查看快捷键命令是不是Ctrl+Alt+i,

  1. 如果不是可以双击键绑定,修改自己想设置的快捷键(注意一定不要和已存的快捷键冲突)

  1. 可以设置新增文件,自动添加文件头部注释,建议设置false,自己手动设置需要添加头部注释的文件更好

"fileheader.configObj": {
    "autoAdd": false, // 检测文件没有头部注释,自动添加文件头部注释
  },
  • 8
    点赞
  • 15
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值