前端自动生成文件头注释/函数注释

写代码的时候，一些公共的注释可以借助插件快速生成。我个人用的是 koroFileHeader ，可以在VSCode的应用商店搜索安装。快捷键的话可以参考 koroFileHeader 的使用文档。

如果出现了这种报错  cannot read property replace of undefined，大概率是你安装了其他的注释插件，可以尝试只保留一个即可解决。

文件头部注释快捷键（默认）：window：ctrl+alt+i

             mac：ctrl+cmd+i

             linux: ctrl+meta+i

             Ubuntu: ctrl+super+i

函数头部注释快捷键（默认）：window：ctrl+alt+t

             mac：ctrl+cmd+t

             linux: ctrl+meta+t

                                   Ubuntu: ctrl+super+t

以下是我的一些配置。

"fileheader.configObj": {
    "createFileTime": true, //设置为true则为文件新建时候作为date，否则注释生成时间为date
    "autoAdd": true, //自动生成注释
    "annotationStr": {
      "head": "/*",
      "middle": " * @",
      "end": " */",
      "use": true //设置自定义注释可用
    },
    "language": {
      "languagetest": {
        "head": "/$$",
        "middle": " $ @",
        "end": " $/"
      }
    },
    "autoAddLine": 100,
    "autoAlready": true,
    "headInsertLine": {
      "php": 2,
      "sh": 2
    },
    "beforeAnnotation": {
      "文件后缀": "该文件后缀的头部注释之前添加某些内容"
    },
    "afterAnnotation": {
      "文件后缀": "该文件后缀的头部注释之后添加某些内容"
    },
    "specialOptions": {
      "特殊字段": "自定义比如LastEditTime/LastEditors"
    },
    "switch": {
      "newlineAddAnnotation": true
    },
    "supportAutoLanguage": [],
    "prohibitAutoAdd": ["json"],
    "prohibitItemAutoAdd": [
      "项目的全称, 整个项目禁止自动添加头部注释, 可以使用快捷键添加"
    ],
    "moveCursor": true,
    "dateFormat": "YYYY-MM-DD HH:mm:ss",
    "atSymbol": ["@", "@"],
    "atSymbolObj": {
      "文件后缀": ["头部注释@符号", "函数注释@符号"]
    },
    "colon": [": ", ": "],
    "colonObj": {
      "文件后缀": ["头部注释冒号", "函数注释冒号"]
    },
    "filePathColon": "路径分隔符替换",
    "showErrorMessage": true,
    "wideSame": false,
    "wideNum": 13,
    "CheckFileChange": false,
    "createHeader": true,
    "useWorker": false,
    "designAddHead": false,
    "headDesignName": "random",
    "headDesign": false,
    "cursorModeInternal": false
  },

"fileheader.customMade": {
   //  文件头部注释
    "Descripttion": "",
    "version": "",
    "Author": "使用者名字",
    "email": "使用者邮箱",
    "Date": "Do not edit",// 创建日期
    "LastEditors": "sj",
    "LastEditTime": "Do not Edit" // 最后修改日期
  },