文件头部注释插件koroFileHeader.md

一、安装vscode插件 koroFileHeader

二、配置插件

1. 找到配置文件

   • 设置 =》 settings => 小图片(open settings), 详见下图

     
     setting.json.png

2. 将如下配置写入配置文件

    // 整体配置
    "fileheader.configObj": {
      "createFileTime": true, // 设置为true则为文件新建时候作为date，否则注释生成时间为date
      "autoAdd": false, // 自动生成注释，老是忘记的同学可以设置
    },
    // 头部注释配置
    "fileheader.customMade": {
      "Author": "写入你的名称", // 创建文件的作者
      "Date": "Do not edit", // 文件创建时间(不变)
      "LastEditors": "写入你的名称", // 文件最后编辑者
      // 由于编辑文件就会变更最后编辑时间，多人协作中合并的时候会导致merge
      // 可以将时间颗粒度改为周、或者月，这样冲突就减少很多。搜索变更时间格式: dateFormat
      "LastEditTime": "Do not edit", // 文件最后编辑时间
      // 输出相对路径，类似: /文件夹名称/src/index.js
      "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
      // 插件会自动将光标移动到Description选项中 方便输入 Description字段可以在specialOptions更改
      "Description": "", // 介绍文件的作用、文件的入参、出参。
      // custom_string_obkoro1~custom_string_obkoro100都可以输出自定义信息
      // 可以设置多条自定义信息 设置个性签名、留下QQ、微信联系方式、输入空行等
      // "custom_string_obkoro1": "", 
      // 版权声明 保留文件所有权利 自动替换年份
      // "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 用户/公司名, All Rights Reserved. "
    },
    // 函数注释配置
    "fileheader.cursorMode": {
      "description": "", // 函数注释生成之后，光标移动到这里
      "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
      "return": "",
    }
   
   

三、快捷键

• ctrl + cmd（win）+ I 文件头部注释（在文件任意位置）
• ctrl + cmd（win）+ T 函数注释（在函数行或者函数上一空白行）