Vscode自动生成文件注释和函数注释插件使用指南

一、插件安装

• 插件名：koroFileHeade

• 插件安装

二、插件配置

• 打开配置文件

• 添加配置

// 函数注释 CTRL+ALT+T
"fileheader.cursorMode": {
  "Function": "",
  "Description": "",
  "Input": "void",
  "Output": "None",
  "Return": "void",
},
// 文件头注释 CTRL+ALT+I
"fileheader.customMade": {
    "Author":"Wang Chong(3436971707qq.com)",
    "Version":"V1.0",
    "Date":"",
    "Description": "",
},
// 插件的配置
"fileheader.configObj": {
  "createFileTime": true,
  "autoAdd":false,  //关闭自动生成头部注释，使用快捷键手动添加
  "prohibitAutoAdd": [ "json", "md" ],
  "wideSame": true, // 设置为true开启
  "wideNum": 13,  // 字段长度 默认为13
  "createHeader": true, // 默认关闭
  "language": {
    "js": {
        "head": "/**",
        "middle": " * @",
        "end": "*/",
    },
    "tsx": { // jsx后缀的文件
      "head": "/**",
      "middle": " * ",
      "end": "*/",
      "functionParams": "typescript" // 使用ts语言的解析逻辑
    }
  },
  "openFunctionParamsCheck": true, // 默认开启
  "cursorModeInternalAll": {
    "ts": true, // ts文件后缀是函数内生成函数注释
    "js": false, // js文件后缀是在函数外生成函数注释
    "python": true, // python语言类型文件时在函数内生成函数注释
    "defaultSetting": false // 默认是在函数外生成注释
  },
  "functionBlankSpaceAll": {
    "js": "", // 单独设置文件：js文件后缀 缩进两格
  },
  "typeParamOrder": "type param", // 参数类型 和 参数的位置自定义
  "functionParamAddStr": "" , // 默认不增加字符串
  "NoMatchParams": "no param",  // 默认不显示param那一行
  "folderBlacklist": [
    "node_modules",
    // "文件夹或文件名禁止自动添加头部注释",
    "webpack.config.js" // 可以禁止某些文件自动添加注释
  ]
},

三、使用方法及效果

• 文件头注释（CTRL+Win+I）

• 函数注释（CTRL+ALT+T）