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

Question

是否有任何eslint-jsdoc规则/设置来强制@private、@public或@protected？有了模块eslint插件jsdoc，就没有规则/设置来强制它

下面的例子应该抛出一个eslint-jsdoc错误：

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

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

也许你可以帮我。谢谢

Answer 1

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

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

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',
},
]
}
}