vscode 中文件的注释头添加配置 工具：koroFileHeader

1 安装插件

插件安装的具体过程可以参照：
链接: 安装参考链接

2 配置setting.json

2.1 例子

本帖目的：最短的时间内配置一个可以使用的注释头。

最详细的配置链接为开发者提供的链接，内容里面有所有的详细解释，由于网络原因，可能不一定打开，因此采用一个最简单的例子进行配置，若有高级要求，请到这里参考开发者的详细解释：链接: 开发者提供的各种注释体解释
例子如下：

分析：1、例子一共有首行，末行和中间行组成，这几行配置的格式是需要单独配置的。
2、例子有名称file,author,brief,version,date,copyright几个关键词组成，其中
file、author、data、copyright四个关键词是根据文件在插入是自动生成的，因此这几个是重点配置对象，一定要配对，才能正常生成。具体的配置方法查看下一节。
3、有两行空白行，与其他行配置不一样。

2.2 根据例子对应setting.json配置

2.2.1解释参考（应用自开发者发布，快速浏览即可）

// 头部注释
"fileheader.customMade": {
    // 头部注释默认字段
    "Author": "your name",
    "Date": "Do not edit", // 设置后默认设置文件生成时间
    "LastEditTime": "Do not edit", // 设置后，保存文件更改默认更新最后编辑时间
    "LastEditors": "your name", // 设置后，保存文件更改默认更新最后编辑人
    "Description": "",
    "FilePath": "Do not edit", // 设置后，默认生成文件相对于项目的路径
    "custom_string_obkoro1": "可以输入预定的版权声明、个性签名、空行等"
},
// 函数注释`在这里插入代码片`
"fileheader.cursorMode": {
  // 默认字段
  "description":"",
  "param":"",
  "return":""
},
// 插件配置项
"fileheader.configObj": {
    "autoAdd": true, // 检测文件没有头部注释，自动添加文件头部注释
    "autoAddLine": 100, // 文件超过多少行数 不再自动添加头部注释
    "autoAlready": true, // 只添加插件支持的语言以及用户通过`language`选项自定义的注释
    "supportAutoLanguage": [], // 设置之后，在数组内的文件才支持自动添加
   // 自动添加头部注释黑名单
   "prohibitAutoAdd": [
      "json"
    ],
   "prohibitItemAutoAdd": [ "项目的全称禁止项目自动添加头部注释, 使用快捷键自行添加" ],
   "folderBlacklist": [ "node_modules" ], // 文件夹或文件名禁止自动添加头部注释
   "wideSame": false, // 头部注释等宽设置
   "wideNum": 13,  // 头部注释字段长度 默认为13
    "functionWideNum": 0, // 函数注释等宽设置 设为0 即为关闭
   // 头部注释第几行插入
    "headInsertLine": {
      "php": 2 // php文件 插入到第二行
    },
    "beforeAnnotation": {}, // 头部注释之前插入内容
    "afterAnnotation": {}, // 头部注释之后插入内容
    "specialOptions": {}, // 特殊字段自定义
    "switch": {
      "newlineAddAnnotation": true // 默认遇到换行符(\r\n \n \r)添加注释符号
    },
    "moveCursor": true, // 自动移动光标到Description所在行
    "dateFormat": "YYYY-MM-DD HH:mm:ss",
    "atSymbol": ["@", "@"], // 更改所有文件的自定义注释中的@符号
    "atSymbolObj": {}, //  更改单独语言/文件的@
    "colon": [": ", ": "], // 更改所有文件的注释冒号
    "colonObj": {}, //  更改单独语言/文件的冒号
    "filePathColon": "路径分隔符替换", // 默认值： mac: / window是: \
    "showErrorMessage": false, // 是否显示插件错误通知 用于debugger
    "writeLog": false, // 错误日志生成
    "CheckFileChange": false, // 单个文件保存时进行diff检查
    "createHeader": true, // 新建文件自动添加头部注释
    "useWorker": false, // 是否使用工作区设置
    "designAddHead": false, // 添加注释图案时添加头部注释
    "headDesignName": "random", // 图案注释使用哪个图案 
    "headDesign": false, // 是否使用图案注释替换头部注释
    // 自定义配置是否在函数内生成注释 不同文件类型和语言类型
    "cursorModeInternalAll": {}, // 默认为false 在函数外生成函数注释
    "openFunctionParamsCheck": true, // 开启关闭自动提取添加函数参数
    "functionParamsShape": ["{", "}"], // 函数参数外形自定义 
    // "functionParamsShape": "no type" 函数参数不需要类型
    "functionBlankSpaceAll": {}, // 函数注释空格缩进 默认为空对象 默认值为0 不缩进
    "functionTypeSymbol": "*", // 参数没有类型时的默认值
    "typeParamOrder": "type param", // 参数类型 和 参数的位置自定义
    // 自定义语言注释，自定义取消 head、end 部分
    // 不设置自定义配置language无效 默认都有head、end
    "customHasHeadEnd": {}, // "cancel head and function" | "cancel head" | "cancel function" 
    "throttleTime": 60000, // 对同一个文件 需要过1分钟再次修改文件并保存才会更新注释
     // 自定义语言注释符号，覆盖插件的注释格式
    "language": {
        // js后缀文件
        "js": {
            "head": "/$$",
            "middle": " $ @",
            "end": " $/",
            // 函数自定义注释符号：如果有此配置 会默认使用
            "functionSymbol": {
              "head": "/******* ", // 统一增加几个*号
              "middle": " * @",
              "end": " */"
            },
            "functionParams": "typescript" // 函数注释使用ts语言的解析逻辑
        },
       // 一次匹配多种文件后缀文件 不用重复设置
       "h/hpp/cpp": {
          "head": "/*** ", // 统一增加几个*号
          "middle": " * @",
          "end": " */"
        },
        // 针对有特殊要求的文件如：test.blade.php
        "blade.php":{
          "head": "<!--",
          "middle": " * @",
          "end": "-->",
        }
    },
 // 默认注释  没有匹配到注释符号的时候使用。
 "annotationStr": { 
      "head": "/*",
      "middle": " * @",
      "end": " */",
      "use": false
    },
}

以上为整个setting.json文件里配置的内容，可能由于升级或者版本不同有一些改变，但是不影响我们最简单功能的使用。接下来就根据上述注释的原版与实际例子设置进行对比，教你用最快的速度，搞一个注释头出来。

2.2.2例子对应的设置

1 配置fileheader.customMade

    "fileheader.customMade": {
        "FilePath": "only file name", 
        "@author": "git config user.name (git config user.email)",
        "@brief": " ",
        "@version": "1.0.0",
        "Date": "Do not edit",
        "custom_string_obkoro2":" ",
        "@copyright": "Copyright (c) ${now_year} Technology. All Rights Reserved.",
        "custom_string_obkoro1":" "
    }

需要注意的点：
1、FilePath、Data是默认的关键字，在我们下载的这个插件里是写死的，我们可以在一个特殊字配置中修改这个关键字，但是在文件头的配置里面必须用默认的字眼。特殊字配置如下：

"specialOptions": {
            "特殊字段": "自定义比如LastEditTime/LastEditors",
            "Date": "@date",
            "FilePath": "@file",
            "LastEditors": "@lastauthor",
        }

这个就相当于给规定的特殊字符起了个别名。
2、only file name和Do not edit也是特殊字眼，必须和特殊的key一一对应，否则会在生成注释时显示这段话。这个显示的FilePath是不带路径的，如果你想配置带路径的，特殊字眼用Do not edit。
3、custom_string_obkoro1和custom_string_obkoro2是插件规定的默认字符，其可以表示空。这俩的作用就是生成例子中那两行空白行。

2 其他配置

a、注释体的模板

"language": {
            "languagetest": {
                "head": "/$$",
                "middle": " $ @",
                "end": " $/",
                "functionSymbol": {
                    "head": "/** ",
                    "middle": " * @",
                    "end": " */"
                },
                "functionParams": "js"
            },
            "h/hpp/cpp/c/cc": {
                "head": "/**", 
                "middle": " * ",
                "end": " */"

        }

需要注意的点：
"h/hpp/cpp/c/cc"这里面配置了头、尾和中间行的固定格式，如果不需要加那两行空行，可以改成

"h/hpp/cpp/c/cc": {
                "head": "/**", 
                "middle": " * @",
                "end": " */"
                }

这样生成的每一行都会有@，开发者里面推荐用atSymbol来设置空行，我试了没成功，暂且用了个笨方法。
2、时间设置

"dateFormat": "YYYY-MM-DD"

根据需要设置日期、时、分、秒。
3、剩下的其他的按需修改

 "colon": [
            " ：",
            " "
        ]

按需设置是否要在你的file、version等词后面是否要加分号还是加空格。

3 插入注释头

需要注意的点：
在你没有对检查的关键字有足够深入的了解时，建议关闭自动插入，否则每次生成或者保存都自动加入注释头，可能会的重复加入，导致代码注释头混乱。

    "autoAdd": false

手动插入的快捷键：
window：ctrl+win+i
mac：ctrl+cmd+i,
linux: ctrl+meta+i
Ubuntu: ctrl+super+i