jsdoc/require-property-description 正しさ

すべての @property タグに説明文が必須であることを要求します。

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

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

javascript

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

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

javascript

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

使い方

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

Config (.oxlintrc.json)CLI

json

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

bash

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