VsCode 添加文件头部注释和函数注释[koroFileHea

一个读取用户自定义模板，通过快捷键添加文件头部注释、在光标处添加函数注释的VsCode插件

简介

1. 文件头部添加注释:

   • 在文件开头添加注释，记录文件信息
   • 支持用户高度自定义注释选项
   • 保存文件的时候，自动更新最后的编辑时间和编辑人
   • 快捷键：window：ctrl+alt+i,mac：ctrl+cmd+i

2. 在光标处添加函数注释:

   • 在光标处自动生成一个注释模板，下方有栗子
   • 支持用户高度自定义注释选项
   • 快捷键：window：ctrl+alt+t,mac：ctrl+cmd+t
   • 快捷键不可用很可能是被占用了,参考这里

3. 支持不同语言的注释格式，如下。

支持注释格式：

• /**/形式：Javascript/Java/go/C++/C

• '''形式：python

• ``形式：html

• '形式： vba

安装

在 Vscode 扩展商店中搜索koroFileHeader,点击安装即可。

使用

1. 文件头部注释：

   在当前编辑文件中使用快捷键:window：ctrl+alt+t/mac：ctrl+cmd+t,即可生成文件头部注释。

2. 函数注释：

   1. 将光标放在函数行或者将光标放在函数上方的空白行
   2. 使用快捷键window：ctrl+alt+t,mac：ctrl+cmd+t，即可生成函数注释。
   3. 事实上，函数注释在文件的任意位置都可生成，这里需要自己控制。

注释模板的设置

• 默认配置:

  在用户首选项中搜索fileheader，默认配置为：

    "fileheader.customMade": {} // 头部注释
    "fileheader.cursorMode": {} // 函数注释 
  复制代码
  

  用户未设置的情况下，头部注释和函数注释模板为：

  image

  <figcaption style="display: block; text-align: center; font-size: 1rem; line-height: 1.6; color: rgb(144, 144, 144); margin-top: 2px;"></figcaption>

• 自定义模板：

  1. 在用户设置中，搜索fileheader

  2. 复制默认配置+修改配置,重启生效

     [图片上传失败...(image-9a3f56-1586483121967)]

     <figcaption style="display: block; text-align: center; font-size: 1rem; line-height: 1.6; color: rgb(144, 144, 144); margin-top: 2px;"></figcaption>

  如上设置，生成注释：

   // 文件头部注释
   /*
    * @Description: 
    * @version: 
    * @Company: BAT
    * @Author: OBKoro1
    * @Date: 2018-10-15 20:59:57
    * @LastEditors: OBKoro1
    * @LastEditTime: 2018-10-15 20:59:57
    */
   // 函数注释
   /**
    * @name: 
    * @test: test font
    * @msg: 
    * @param {type} 
    * @return: 
    */
  复制代码
  

自动更新最后编辑时间、编辑人：

要开启这个功能，需要在首选项设置中填写对应的属性：

  "fileheader.customMade": {
    "Date": "Do not edit", // 文件创建时间(不变)
    "LastEditors": "OBKoro1", // 文件最后编辑者
    "LastEditTime": "Do not edit" // 文件最后编辑时间
  }
  // 不填写对应属性即关闭对应功能
复制代码

自动更新编辑时间

示例: