OBKoro1/koro1FileHeader

mdx后缀不能自定义注释符号

Closed this issue · 2 comments

xiongsp commented

注意！很多问题都可以在配置字段查看所有配置中和issue里得到解决！

注意！很多问题都可以在配置字段查看所有配置中和issue里得到解决！

注意！很多问题都可以在配置字段查看所有配置中和issue里得到解决！

注意：

  1. 可以先试一下常见问题中的方法.
  2. 然后搜一搜以前关闭的issue看有没有相似的问题可以帮助解决问题。
  3. 打开fileheader.configObj.showErrorMessage看看没有没有报错信息
  4. issue提的越清晰，越容易定位问题/找到bug，越快速的解决问题。

注意！请一定要按照规范来提Issue，这样问题能更快的得到解决！

注意！请一定要按照规范来提Issue，这样问题能更快的得到解决！

注意！请一定要按照规范来提Issue，这样问题能更快的得到解决！

描述bug(必填)

mdx文件不能自定义后缀捏

注释设置(必填):

VsCode设置：

"fileheader.configObj": {
    "autoAdd": false, // 检测文件没有头部注释，自动添加文件头部注释
    "autoAddLine": 300, // 文件超过多少行数 不再自动添加头部注释
    "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": false, // 新建文件自动添加头部注释
    "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": "-->",
      // }
      "mdx": {
        "head": "{/*",
        "middle": " * @",
        "end": "*/}",
      }
    },
    // 默认注释  没有匹配到注释符号的时候使用。
    // "annotationStr": {
    //   "head": "/*",
    //   "middle": " * @",
    //   "end": " */",
    //   "use": false
    // }
  }

文件后缀(必填):mdx

如：test.js 的后缀为 js

你得到的注释(必填):不生成

你生成的注释为：

无

也可以贴上截图：

预期的行为(必填)：

预期得到的注释/行为：

// 预期行为的注释贴在这里
{/*something*/}

也可以贴上截图：

屏幕截图(选填)

如果方便的话，添加截图来帮助解释你的问题：

问题相关(选填)

在这里添加关于这个问题的任何其他上下文。

错误日志(选填):

怎么生成错误日志?

hhl-web commented

哈喽，是否有复现截图呢？比如你写的函数...

  • ❤️1
OBKoro1 commented

@xiongsp 使用你提供的配置可以正常自定义注释符号。

image