Javascript - 哪个 eslint jsdoc 规则/设置强制 @private、@public 或 @protected

Question

是否有任何 eslint jsdoc 规则/设置来强制 @private、@public 或 @protected？使用模块 eslint-plugin-jsdoc 没有强制的规则/设置它。

以下示例应引发 eslint jsdoc 错误：

/**
 * @param {string} foo
 */
function quux (foo) {

}

不应接受此 jsDoc，因为 @private、@public 或 @protected 不可用。

也许你可以帮助我。 谢谢。

Answer 1

您可以使用 jsdoc/no-restricted-syntax 规则，禁止没有这些访问修饰符的块。

将其添加到您的 eslint 配置文件中：

rules: {
  'jsdoc/no-restricted-syntax': ['error', {
    contexts: [
      {
        comment: 'JsdocBlock:not(JsdocBlock:has(JsdocTag[tag=/private|protected|public/]))',
        context: 'any',
        message: 'Access modifier tags must be present',
      },
    ]
  }
}