jsdoc/check-access 制限

何をするか

@access タグが次のいずれかの値を使用していることをチェックします：

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

また、以下の状況を報告します：

同じドキュメントブロック内で @access と @public、@private、@protected、@package が混在している。
同じドキュメントブロック内で複数回 @access（または @public など）が使用されている。

なぜこれは悪いのか

JSDoc コメント内でアクセスレベルを一貫した方法で指定することは重要です。無効な値や複数のアクセスレベルタグを使用すると、ドキュメント化された要素の意図される可視性について混乱を招き、API ドキュメント生成時に不整合を引き起こす可能性があります。異なるアクセスタグを混在させたり、無効な値を使用したりすると、ドキュメントが不明瞭になり、誤解を招くことがあります。

例

このルールに対して誤りなコードの例：

javascript

/** @access private @public */

/** @access invalidlevel */

このルールに対して正しいコードの例：

javascript

/** @access private */

/** @private */

使い方

設定ファイルまたは CLI でこのルールを有効化するには、次のように使用できます：

Config (.oxlintrc.json)CLI

json

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

bash

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

参照

ルールのソース

何をするか ​

なぜこれは悪いのか ​

例 ​

使い方 ​

参照 ​

何をするか

なぜこれは悪いのか

例

使い方

参照