← Back to rules

jsdoc/check-access 限制

它的作用

检查 @access 标签是否使用以下值之一：

• "package", "private", "protected", "public"

同时报告以下情况：

• 在同一文档块中混合使用 @access 与 @public、@private、@protected 或 @package。
• 在同一文档块中多次使用 @access（或 @public 等）标签。

为什么这是不好的？

在 JSDoc 注释中以一致的方式指定访问级别非常重要。使用无效或多个访问级别标签会让人对被注释元素的预期可见性产生混淆，并可能导致 API 文档生成中的不一致。混合使用不同的访问标签或使用无效值会使文档变得模糊且可能具有误导性。

示例

此规则的 错误 代码示例：

/** @access private @public */

/** @access invalidlevel */

此规则的 正确 代码示例：

/** @access private */

/** @private */

如何使用

要通过配置文件或 CLI 启用 此规则，可以使用：

配置 (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/check-access": "error"
  }
}

CLI

oxlint --deny jsdoc/check-access --jsdoc-plugin

参考资料

• 规则源码