vscode之生成文件头部注释和函数注释的插件koroFileHeader

625 阅读1分钟

一、在vscode商店 搜索添加koroFileHeader 插件,安装之后reload插件;

image.png

二、找到code--首选项--setting(快捷键MAC是"command,"),搜索fileHeader,就可以进行配置

image.png

三、点击对应setting.json就可以进行配置了 企业微信20220407-133726@2x.png 配置代码如下:

"fileheader.configObj": {
    "createFileTime": true, // 设置为true则为文件新建时候作为date,否则注释生成时间为date
    "autoAdd": true, // 自动生成注释,老是忘记的同学可以设置
    "annotationStr": {
      "head": "/*",
      "middle": " * @",
      "end": " */",
      "use": true // 设置自定义注释可用
    },
    "headInsertLine": {
      "php": 2
    }
  },
  "fileheader.cursorMode": {
    "description": "",
    "param ": "",
    "return": ""
  },
  "fileheader.customMade": {
    "Author": "xxx/*  */ ", // 编辑人
    "Date": "Do not edit",//时间
    "Description": "", // 文件内容描述
  }

使用

  1. 在 Vscode 中打开文件
  2. control+command+i

便可以成功在文件头部插入文件注释