Missing JSDoc @param "opts" description.eslint(jsdoc/require-param-description)

在我们正常写注释的时候eslint会报飘红,然后报Missing JSDoc @param "opts" description.eslint(jsdoc/require-param-description)错误,如下图:

 

 其实就是eslint要求我们参数要有描述,返回值要有返回类型,两种解决办法:

1.根据他的要求定义我们的注释:

 

 2.在我们的.eslintrc文件的rules下面加上如下配置,这样可以解决这个问题:

"valid-jsdoc": [
      true,
      {
        "prefer": {
          "return": "returns"
        },
        "requireParamType": false,
        "requireReturn": false,
        "requireReturnType": false
      }
    ]

希望对你有用。

posted @ 2022-09-16 15:10  鸡腿太小  阅读(419)  评论(0编辑  收藏  举报