前言

安利一个vscode插件， 用于生成文件头部注释和函数注释的插件 效果如下
image.png

安装

vscode 插件商店搜 koroFileHeader

image.png

配置

  • 选择 文件——首选项 ——— 设置
  • 搜索 fileheader.customMade， 打开 setting.json 文件

image.png

  • 用下面的代码覆盖原来的配置，
  • 下面配置中的Author 记住改成你自己的名字
  1. "fileheader.customMade": {
  3.     "Author": "onino", // 改成你的名字
  4.     "Date": "", // 文件创建时间
  5.     "LastEditors": "onino", // 文件最后编辑者
  6.     "LastEditTime": "", // 文件最后编辑时间
  7.     "Description":"请填写简介",
  8. },
  10. "fileheader.configObj": {
  11.     "CheckFileChange": true, // 默认关闭
  12.     "wideSame": false, // 设置为true开启
  13.     "wideNum": 13, // 字段长度 默认为13
  14.     "createHeader": true // 创建文件自动添加注释
  15. },

image.png

  • 重启 vscode

其它配置项：

  1. // 头部注释
  2. "fileheader.customMade": {
  3.     // Author字段是文件的创建者 可以在specialOptions中更改特殊属性
  4.     // 公司项目和个人项目可以配置不同的用户名与邮箱 搜索: gitconfig includeIf  比如: https://ayase.moe/2021/03/09/customized-git-config/
  5.     // 自动提取当前git config中的: 用户名、邮箱
  6.     "Author": "git config user.name && git config user.email", // 同时获取用户名与邮箱
  7.     // "Author": "git config user.name", // 仅获取用户名
  8.     // "Author": "git config user.email", // 仅获取邮箱
  9.     // "Author": "OBKoro1", // 写死的固定值 不从git config中获取
  10.     "Date": "Do not edit", // 文件创建时间(不变)
  11.     // LastEditors、LastEditTime、FilePath将会自动更新 如果觉得时间更新的太频繁可以使用throttleTime(默认为1分钟)配置更改更新时间。
  12.     "LastEditors": "git config user.name && git config user.email", // 文件最后编辑者 与Author字段一致
  13.     // 由于编辑文件就会变更最后编辑时间，多人协作中合并的时候会导致merge
  14.     // 可以将时间颗粒度改为周、或者月，这样冲突就减少很多。搜索变更时间格式: dateFormat
  15.     "LastEditTime": "Do not edit", // 文件最后编辑时间
  16.     // 输出相对路径，类似: /文件夹名称/src/index.js
  17.     "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
  18.     // 插件会自动将光标移动到Description选项中 方便输入 Description字段可以在specialOptions更改
  19.     "Description": "", // 介绍文件的作用、文件的入参、出参。
  20.     // custom_string_obkoro1~custom_string_obkoro100都可以输出自定义信息
  21.     // 可以设置多条自定义信息 设置个性签名、留下QQ、微信联系方式、输入空行等
  22.     "custom_string_obkoro1": "", 
  23.     // 版权声明 保留文件所有权利 自动替换年份 获取git配置的用户名和邮箱
  24.     // 版权声明获取git配置, 与Author字段一致: ${git_name} ${git_email} ${git_name_email}
  25.     "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by ${git_name_email}, All Rights Reserved. "
  26.     // "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 写死的公司名/用户名, All Rights Reserved. "
  27. },
  28. // 函数注释
  29. "fileheader.cursorMode": {
  30.     "description": "", // 函数注释生成之后，光标移动到这里
  31.     "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
  32.     "return": "",
  33. },
  34. // 插件配置项
  35. "fileheader.configObj": {
  36.     "autoAdd": true, // 检测文件没有头部注释，自动添加文件头部注释
  37.     "autoAddLine": 100, // 文件超过多少行数 不再自动添加头部注释
  38.     "autoAlready": true, // 只添加插件支持的语言以及用户通过`language`选项自定义的注释
  39.     "supportAutoLanguage": [], // 设置之后，在数组内的文件才支持自动添加
  40.    // 自动添加头部注释黑名单
  41.    "prohibitAutoAdd": [
  42.       "json"
  43.     ],
  44.    "prohibitItemAutoAdd": [ "项目的全称禁止项目自动添加头部注释, 使用快捷键自行添加" ],
  45.    "folderBlacklist": [ "node_modules" ], // 文件夹或文件名禁止自动添加头部注释
  46.    "wideSame": false, // 头部注释等宽设置
  47.    "wideNum": 13,  // 头部注释字段长度 默认为13
  48.     "functionWideNum": 0, // 函数注释等宽设置 设为0 即为关闭
  49.    // 头部注释第几行插入
  50.     "headInsertLine": {
  51.       "php": 2 // php文件 插入到第二行
  52.     },
  53.     "beforeAnnotation": {}, // 头部注释之前插入内容
  54.     "afterAnnotation": {}, // 头部注释之后插入内容
  55.     "specialOptions": {}, // 特殊字段自定义 比如: Author、LastEditTime、LastEditors、FilePath、Description、Date等
  56.     "switch": {
  57.       "newlineAddAnnotation": true // 默认遇到换行符(\r\n \n \r)添加注释符号
  58.     },
  59.     "moveCursor": true, // 自动移动光标到Description所在行
  60.     "dateFormat": "YYYY-MM-DD HH:mm:ss",
  61.     "atSymbol": ["@", "@"], // 更改所有文件的自定义注释中的@符号
  62.     "atSymbolObj": {}, //  更改单独语言/文件的@
  63.     "colon": [": ", ": "], // 更改所有文件的注释冒号
  64.     "colonObj": {}, //  更改单独语言/文件的冒号
  65.     "filePathColon": "路径分隔符替换", // 默认值： mac: / window是: \
  66.     "showErrorMessage": false, // 是否显示插件错误通知 用于debugger
  67.     "writeLog": false, // 错误日志生成
  68.     "CheckFileChange": false, // 单个文件保存时进行diff检查
  69.     "createHeader": false, // 新建文件自动添加头部注释
  70.     "useWorker": false, // 是否使用工作区设置
  71.     "designAddHead": false, // 添加注释图案时添加头部注释
  72.     "headDesignName": "random", // 图案注释使用哪个图案 
  73.     "headDesign": false, // 是否使用图案注释替换头部注释
  74.     // 自定义配置是否在函数内生成注释 不同文件类型和语言类型
  75.     "cursorModeInternalAll": {}, // 默认为false 在函数外生成函数注释
  76.     "openFunctionParamsCheck": true, // 开启关闭自动提取添加函数参数
  77.     "functionParamsShape": ["{", "}"], // 函数参数外形自定义 
  78.     // "functionParamsShape": "no type" 函数参数不需要类型
  79.     "functionBlankSpaceAll": {}, // 函数注释空格缩进 默认为空对象 默认值为0 不缩进
  80.     "functionTypeSymbol": "*", // 参数没有类型时的默认值
  81.     "typeParamOrder": "type param", // 参数类型 和 参数的位置自定义
  82.     "NoMatchParams": "no show param", // 没匹配到函数参数，是否显示@param与@return这两行 默认不显示param
  83.     "functionParamAddStr": "", // 在 type param 后面增加字符串 可能是冒号，方便输入参数描述
  84.     // 自定义语言注释，自定义取消 head、end 部分
  85.     // 不设置自定义配置language无效 默认都有head、end
  86.     "customHasHeadEnd": {}, // "cancel head and function" | "cancel head" | "cancel function" 
  87.     "throttleTime": 60000, // 对同一个文件 需要过1分钟再次修改文件并保存才会更新注释
  88.      // 自定义语言注释符号，覆盖插件的注释格式
  89.     "language": {
  90.         // js后缀文件
  91.         "js": {
  92.             "head": "/$$",
  93.             "middle": " $ @",
  94.             "end": " $/",
  95.             // 函数自定义注释符号：如果有此配置 会默认使用
  96.             "functionSymbol": {
  97.               "head": "/******* ", // 统一增加几个*号
  98.               "middle": " * @",
  99.               "end": " */"
  100.             },
  101.             "functionParams": "typescript" // 函数注释使用ts语言的解析逻辑
  102.         },
  103.        // 一次匹配多种文件后缀文件 不用重复设置
  104.        "h/hpp/cpp": {
  105.           "head": "/*** ", // 统一增加几个*号
  106.           "middle": " * @",
  107.           "end": " */"
  108.         },
  109.         // 针对有特殊要求的文件如：test.blade.php
  110.         "blade.php":{
  111.           "head": "<!--",
  112.           "middle": " * @",
  113.           "end": "-->",
  114.         }
  115.     },
  116.  // 默认注释  没有匹配到注释符号的时候使用。
  117.  "annotationStr": { 
  118.       "head": "/*",
  119.       "middle": " * @",
  120.       "end": " */",
  121.       "use": false
  122.     },
  123. }

测试

文件头部添加注释:

  • 在文件开头添加注释，记录文件信息/文件的传参/出参等
  • 支持用户高度自定义注释选项, 适配各种需求和注释。
  • 保存文件的时候，自动更新最后的编辑时间和编辑人
  • 快捷键：window：ctrl+win+i,mac：ctrl+cmd+i, linux: ctrl+meta+i

在光标处添加函数注释:

  • 在光标处自动生成一个注释模板, 自动解析函数参数，生成函数参数注释。
  • 支持用户高度自定义注释选项
  • 快捷键：window：ctrl+alt+t,mac：ctrl+cmd+t,linux: ctrl+meta+t