← Back to rules

jsdoc/require-property-type 整合性

何を実行するか

各 @property タグに型値（中括弧内）が存在することを要求します。

なぜ問題なのか

プロパティの型は文書化されるべきです。

例

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

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

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

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

使用方法

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

Config (.oxlintrc.json)

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

CLI

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

参照

• ルールのソース