vscode 自动生成注释 koroFileHeader

koroFileHeader是一款用于在vscode中用于生成文件头部注释和函数注释的插件,支持所有主流语言,功能强大,灵活方便。

  • 文件头部注释:在当前编辑文件中使用快捷键:windowctrl+alt+t/macctrl+cmd+t,即可生成文件头部注释。
  • 函数注释:
    1. 将光标放在函数行或者将光标放在函数上方的空白行
    2. 使用快捷键windowctrl+alt+t,macctrl+cmd+t,即可生成函数注释。
  1. // 头部注释
  2. “fileheader.customMade”: {
  3.     // 头部注释默认字段
  4.     “Author”“your name”,
  5.     “Date”“Do not edit”// 设置后默认设置文件生成时间
  6.     “LastEditTime”“Do not edit”// 设置后,保存文件更改默认更新最后编辑时间
  7.     “LastEditors”“your name”// 设置后,保存文件更改默认更新最后编辑人
  8.     “Description”“”,
  9.     “FilePath”“Do not edit”// 设置后,默认生成文件相对于项目的路径
  10.     “custom_string_obkoro1”“可以输入预定的版权声明、个性签名、空行等”
  11. },
  12. // 函数注释
  13. “fileheader.cursorMode”: {
  14.   // 默认字段
  15.   “description”:“”,
  16.   “param”:“”,
  17.   “return”:“”
  18. },
  19. // 插件配置项
  20. “fileheader.configObj”: {
  21.     “autoAdd”true// 检测文件没有头部注释,自动添加文件头部注释
  22.     “autoAddLine”: 100, // 文件超过多少行数 不再自动添加头部注释
  23.     “autoAlready”true// 只添加插件支持的语言以及用户通过`language`选项自定义的注释
  24.     “supportAutoLanguage”: [], // 设置之后,在数组内的文件才支持自动添加
  25.    // 自动添加头部注释黑名单
  26.    “prohibitAutoAdd”: [
  27.       “json”
  28.     ],
  29.     “prohibitItemAutoAdd”: [ “项目的全称禁止项目自动添加头部注释, 使用快捷键自行添加” ],
  30.     “wideSame”false// 头部注释等宽设置
  31.    “wideNum”: 13,  // 头部注释字段长度 默认为13
  32.    // 头部注释第几行插入
  33.     “headInsertLine”: {
  34.       “php”: 2 // php文件 插入到第二行
  35.     },
  36.     “beforeAnnotation”: {}, // 头部注释之前插入内容
  37.     “afterAnnotation”: {}, // 头部注释之后插入内容
  38.     “specialOptions”: {}, // 特殊字段自定义
  39.     “switch”: {
  40.       “newlineAddAnnotation”true // 默认遇到换行符(\r\n \n \r)添加注释符号
  41.     },
  42.     “moveCursor”true// 自动移动光标到Description所在行
  43.     “dateFormat”“YYYY-MM-DD HH:mm:ss”,
  44.     “atSymbol”: [“@”“@”], // 更改所有文件的自定义注释中的@符号
  45.     “atSymbolObj”: {}, //  更改单独语言/文件的@
  46.     “colon”: [“: ““: “], // 更改所有文件的注释冒号
  47.     “colonObj”: {}, //  更改单独语言/文件的冒号
  48.     “filePathColon”“路径分隔符替换”// 默认值: mac: / window是: \
  49.      “showErrorMessage”false// 是否显示插件错误通知 用于debugger
  50.     “CheckFileChange”false// 单个文件保存时进行diff检查
  51.     “createHeader”true// 新建文件自动添加头部注释
  52.     “useWorker”false// 是否使用工作区设置
  53.     “designAddHead”false// 添加注释图案时添加头部注释
  54.     “headDesignName”“random”// 图案注释使用哪个图案 
  55.     “headDesign”false// 是否使用图案注释替换头部注释
  56.     “cursorModeInternal”false,  // 是否在函数内生成函数注释
  57.      // 自定义语言注释符号,覆盖插件的注释格式
  58.     “language”: {
  59.         “java”: {
  60.             “head”“/$$”,
  61.             “middle”” $ @”,
  62.             “end”” $/”
  63.         },
  64.        // 一次匹配多种文件后缀文件 不用重复设置
  65.        “h/hpp/cpp”: {
  66.           “head”“/*** “// 统一增加几个*号
  67.           “middle”” * @”,
  68.           “end”” */”
  69.         },
  70.         // 针对有特殊要求的文件如:test.blade.php
  71.         “blade.php”:{
  72.           “head”“<!–“,
  73.           “middle”” * @”,
  74.           “end”“–>”,
  75.         }
  76.     },
  77.  // 默认注释  没有匹配到注释符号的时候使用。
  78.  “annotationStr”: {
  79.       “head”“/*”,
  80.       “middle”” * @”,
  81.       “end”” */”,
  82.       “use”false
  83.     },
  84. }

发表评论

电子邮件地址不会被公开。 必填项已用*标注