快速代码注释koroFileHeader

348 阅读1分钟

安装

在插件中查询插件koroFileHeader,安装

 

配置

在settings中搜索Fileheader.cursorMode,点击编辑json

编辑如下:

fileheader.customMade": { // 头部注释
          "Author": "11121",
          "Date": "Do not edit",
          "LastEditors": "111221",
          "LastEditTime": "Do not edit",
          "Description": "file content",
          "FilePath": "Do not edit" // 增加此项配置即可
      },
      "fileheader.cursorMode": { // 函数注释
          "description": "",
          "param": "params",
      },
      "fileheader.configObj": {
          "autoAdd": true, // 默认开启自动添加头部注释,当文件没有设置头部注释时保存会自动添加
          "autoAlready": true, // 默认开启
          "prohibitAutoAdd": [
              "json",
              "md"
          ], // 禁止.json .md文件,自动添加头部注释
          "wideSame": false, // 设置为true开启
          "wideNum": 13 // 字段长度 默认为13
      }

使用

在文件头部注释

在文件头行点击插入光标,windos快捷键ctrl+alt+i mac快捷键ctrl+command+i 

在函数头设置

函数没有自动添加,在函数上一行点击插入光标,windos快捷键ctrl+alt+tmac快捷键ctrl+command+t

配方妙处

1、从注释上可以看出是谁创建,谁修改
2、从注释上可以看出最后修改时间(保存时会自动更新)