vscode代码注释器配置

1、在vscode插件中安装koroFileHeader。

2、快捷键打开setting.json。

ctrl+shift+p组合键后如下图所示：

打开用户名的setting,json即可。

然后添加以下配置：

{
  "workbench.colorTheme": "Snazzy Light",
    "terminal.integrated.inheritEnv": false,
    "git.openRepositoryInParentFolders": "always",    
    "liveServer.settings.donotShowInfoMsg": true,
    "editor.fontSize": 16,
    "security.workspace.trust.untrustedFiles": "open",    
    "workbench.iconTheme": "vscode-icons-mac",
    "files.associations": {
        "*.cjson": "jsonc",
        "*.wxss": "css",
        "*.wxs": "javascript"
    },
    "emmet.includeLanguages": {
        "wxml": "html"
    },
    "minapp-vscode.disableAutoConfig": true,
    "liveServer.settings.ignoreFiles": [

        ".vscode/**",
        "**/*.scss",
        "**/*.sass",
        "**/*.ts"
    ],    
    // 头部注释
    "fileheader.customMade": {
      // 头部注释默认字段
      "Author": "PGF",
      "Date": "Do not edit", // 设置后默认设置文件生成时间
      "LastEditTime": "Do not edit", // 设置后，保存文件更改默认更新最后编辑时间
      "LastEditors": "PGF", // 设置后，保存文件更改默认更新最后编辑人
      "Description": "The function of this file is ",
      "FilePath": "", // 设置后，默认生成文件相对于项目的路径
      // "custom_string_obkoro1": "华擎创新版权声明",
      "custom_string_obkoro1":"Copyright (c) ${now_year} by pgf email: nchu_pgf@163.com, All Rights Reserved."
    },
    // 函数注释
    "fileheader.cursorMode": {
      // 默认字段
      "Prototype":"",
      "description":"The function of this function is ",
      "Author": "PGF",
      "Date": "", // 设置后默认设置文件生成时间
      "Modification":"Create",
      "param":"",    
      "return":"",
    },
    // 插件配置项
    "fileheader.configObj": {
      "autoAdd": true, // 检测文件没有头部注释，自动添加文件头部注释
      "autoAddLine": 500, // 文件超过多少行数 不再自动添加头部注释
      "autoAlready": true, // 只添加插件支持的语言以及用户通过`language`选项自定义的注释
      "supportAutoLanguage": [], // 设置之后，在数组内的文件才支持自动添加
      // 自动添加头部注释黑名单
      "prohibitAutoAdd": [
        "json",
        "md"
      ],
      "prohibitItemAutoAdd": [ "项目的全称禁止项目自动添加头部注释, 使用快捷键自行添加" ],
      "folderBlacklist": [ "node_modules" ], // 文件夹或文件名禁止自动添加头部注释
      "wideSame": true, // 头部注释等宽设置
      "wideNum": 13,  // 头部注释字段长度 默认为13
      "functionWideNum": 15, // 函数注释等宽设置 设为0 即为关闭
      // 头部注释第几行插入
      "headInsertLine": {
        "php": 2 // php文件 插入到第二行
      },
      "beforeAnnotation": {
        "py": "#!/usr/bin/env python\n# coding=utf-8", // py文件默认，可修改
        "*": "\n" // 所有文件的头部注释都在前面增加一个换行(除了py)
      }, // 头部注释之前插入内容
      "afterAnnotation": {
        "js": "// js文件头部注释之后的内容", 
        "*": "\n" // 所有文件新增头部注释之后都空一行(除了js)
      }, // 头部注释之后插入内容
      "specialOptions": {
        "Author": "creater",
        "Date": "since",
        "LastEditTime": "lastTime",
        "LastEditors": "LastAuthor",
        "Description": "message", // 头部注释大写的描述Description
        "description": "function message", // 函数注释小写的描述：description
        "FilePath": "文件相对于项目的路径",
        "param": "Input", // 函数注释parm参数别名
        "return": "Output", //函数注释返回值别名
        // 文件后缀、或者语言后缀，可针对单个文件后缀进行配置：language的自定义语言配置
        "js": {
            "Description": "message2",  // 合并specialOptions第一层级的配置，覆盖Description的配置
            "return": "return2", // 单独为js文件添加return 特殊字段配置
        },
        "md": {
          "Date": "date",
          "Description": "tag"
        }
      }, // 特殊字段自定义
      "switch": {
        "newlineAddAnnotation": true // 默认遇到换行符(\r\n \n \r)添加注释符号
      },
      "moveCursor": true, // 自动移动光标到Description所在行
      "dateFormat": "YYYY-MM-DD HH:mm:ss",
      "atSymbol": ["*@", "*@"], // 更改所有文件的自定义注释中的@符号
      "atSymbolObj": {
        "js": ["", "@"], // .js文件的头部注释@符号去掉,所有文件的函数注释默认为@
        "java": [ "#", "@"] // .java文件 头部注释@改为#, 函数注释还是@
      }, //  更改单独语言/文件的@
      "colon": [": ", ": "], // 更改所有文件的注释冒号
      "colonObj": {
        "js": [ " ", ": " ], // .js文件 头部注释去掉: 留一个空格 函数注释保留冒号
        "java": [ ": ", "$"] // .java文件 头部注释是冒号 函数注释是$
      }, //  更改单独语言/文件的冒号
      "filePathColon": "/", // 默认值： mac: / window是: \
      "showErrorMessage": false, // 是否显示插件错误通知 用于debugger
      "writeLog": false, // 错误日志生成
      "CheckFileChange": false, // 单个文件保存时进行diff检查
      "createHeader": true, // 新建文件自动添加头部注释
      "useWorker": false, // 是否使用工作区设置
      "designAddHead": true, // 添加注释图案时添加头部注释
      "headDesignName": "random", // 图案注释使用哪个图案 
      "headDesign": false, // 是否使用图案注释替换头部注释
      // 自定义配置是否在函数内生成注释 不同文件类型和语言类型
      "cursorModeInternalAll": {
        "ts": true, // ts文件后缀是函数内生成函数注释
        "js": false, // js文件后缀是在函数外生成函数注释
        "python": true, // python语言类型文件时在函数内生成函数注释
        "defaultSetting": false // 默认是在函数外生成注释
      }, // 默认为false 在函数外生成函数注释
      "openFunctionParamsCheck": true, // 开启关闭自动提取添加函数参数
      "functionParamsShape": ["{", "}"], // 函数参数外形自定义
      "functionBlankSpaceAll": {
        "js": 2, // 单独设置文件：js文件后缀 缩进两格
        "python": 4, // 设置语言：python语言类型 函数注释空格缩进4格
        "defaultSetting": 0  // 不设置 默认值为0
      }, // 函数注释空格缩进 默认为空对象 默认值为0 不缩进
      "functionTypeSymbol": "*", // 参数没有类型时的默认值
      "typeParamOrder": "type param", // 参数类型 和 参数的位置自定义
      "functionParamAddStr": "", // 默认不增加字符串
      "NoMatchParams": "no param", // 默认不显示param那一行
      // 自定义语言注释，自定义取消 head、end 部分
      // 不设置自定义配置language无效 默认都有head、end
      "customHasHeadEnd": {
        "js": "cancel head and function", // 头部注释和函数注释均不取消head和end - 单独设置文件 js文件后缀
        "ts": "cancel function", // 函数注释不带有head和end-ts文件后缀
        "python": "cancel head", // 头部注释不带有head和end
        // "defaultSetting": ''  // 不设置 默认所有文件都有head和end
      }, // "cancel head and function" | "cancel head" | "cancel function" 
      "throttleTime": 60000, // 对同一个文件 需要过1分钟再次修改文件并保存才会更新注释
        // 自定义语言注释符号，覆盖插件的注释格式
      "language": {
          // js后缀文件
          "js": {
              "head": "/$$",
              "middle": " $ @",
              "end": " $/",
              // 函数自定义注释符号：如果有此配置 会默认使用
              "functionSymbol": {
                "head": "/******* ", // 统一增加几个*号
                "middle": " * @",
                "end": " */"
              }
          },
          // 一次匹配多种文件后缀文件 不用重复设置
          "h/hpp/cpp": {
            "head": "/********************************************************** ", // 统一增加几个*号
            "middle": " * ",
            "end": " **********************************************************/"
          },
          // 针对有特殊要求的文件如：test.blade.php
          "blade.php":{
            "head": "<!--",
            "middle": " * @",
            "end": "-->",
          }
      },
    // 默认注释  没有匹配到注释符号的时候使用。
    "annotationStr": { 
        "head": "/*",
        "middle": " * @",
        "end": " */",
        "use": false
      },
    }    
}

3、修改完后直接重启vscode开始生效。

4、相关快捷键：

文件头注释添加：ctrl+win+i

文件头注释添加特殊图案：ctrl+win+j

函数头注释添加：ctrl+win+t

函数注释中参数切换：ctrl+win+y