← Back to rules

jsdoc/require-property-name 正しさ

何を行うか

すべての @property タグに名前が存在することを要求します。

なぜ問題なのか

プロパティの型の名前はドキュメント化されるべきです。

例

このルールに違反するコードの例:

/**
 * @typedef {SomeType} SomeTypedef
 * @property {number}
 */

このルールに準拠するコードの例:

/**
 * @typedef {SomeType} SomeTypedef
 * @property {number} foo
 */

使用方法

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

Config (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/require-property-name": "error"
  }
}

CLI

oxlint --deny jsdoc/require-property-name --jsdoc-plugin

参照

• ルールのソース