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

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

language

简体中文 | English

项目地址:传送门

简介

  1. 文件头部添加注释:

    • 在文件开头添加注释,记录文件信息
    • 读取用户设置,生成注释模板
    • 保存文件的时候,自动更新最后的编辑时间和编辑人
    • 快捷键:windowctrl+alt+i,macctrl+cmd+i
  2. 在光标处添加函数注释:

    • 在光标处自动生成一个注释模板,下方有栗子
    • 支持用户自定义文件注释模板
    • 快捷键:windowctrl+alt+t,macctrl+cmd+t

安装

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

使用

  1. 文件头部注释:

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

  2. 函数注释:

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

注释模板的设置

  • 默认配置:

    在用户首选项中搜索fileheader,默认配置为:

      "fileheader.customMade": {} // 头部注释
      "fileheader.cursorMode": {} // 函数注释 
    

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

  • 自定义模板:

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

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

    如上设置,生成注释:

     // 文件头部注释
     /*
      * @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" // 文件最后编辑时间
  }
  // 不填写对应属性即关闭对应功能

自动更新编辑时间

示例:

最后

如果觉得还不错的话,就给个 Star ⭐️ 鼓励一下我吧~

博客前端积累文档公众号GitHub

Last Updated: 10/16/2018, 2:16:17 PM