koroFileHeader 非常实用的Vscode 插件[用于添加文件头部注释]

前言

本来之前也安装过一个头部文件注释的插件：vscode-fileheader，由于插件的注释模板都是定死的，想要自己定制一些模板注释也不行，实在用的不舒服，然后自己去研究了一番，参考vscode-fileheader插件的一些内容，开发了这个插件。

koroFileHeader

在 VsCode 中通过快捷键ctrl+alt+i在文件头部添加注释。

language

English | 简体中文

简介

• vscode扩展插件
• 在文件头中添加注释
• 支持用户自定义文件注释模板对象
• 在你保存文件的时候 自动更新编辑时间

安装

在 Vscode 扩展商店中搜索 koroFileHeader

使用

1. 在 Vscode 中打开文件
2. 按 ctrl+alt+i

成功在文件头部插入文件注释

注释模板

默认注释模板

• 默认配置:

  "fileheader.customMade": {
      "Author": "OBKoro1",
      "Date": "Do not edit",
      "LastEditors": "OBKoro1",
      "LastEditTime": "Do not edit",
      "Description": "",
  }

• 文件注释生成:

  /*
   * @Author:OBKoro1
   * @Date:2018-05-15 16:20:04
   * @LastEditors:OBKoro1
   * @LastEditTime:2018-05-15 16:20:04
   * @Description:
   */

推荐模板参数

Email、Company、version等.

自定义注释模板

1. 在 VsCode 设置中搜索fileheader.customMade
2. 复制默认配置+修改配置
3. 重启 VsCode 生效

Example

• 设置：

• 文件注释生成:

  /*
   * @Author: OBKoro1
   * @Date: 2018-05-16 12:33:57
   * @LastEditors: OBKoro1
   * @LastEditTime: 2018-05-16 12:33:57
   * @Description: 
   * @Email: your Email
   * @Company: your company
   * @youWant: add you want
   */

自动更新编辑时间 示例:

微信公众号

关注我的微信公众号，每月会发几篇技术博客，有问题可以一起交流，相互学习，共同进步。

最后

如果我的项目解决了你的问题或者是觉得还不错的话，就给个 star 鼓励一下吧~