← Back to rules

jsdoc/require-property-description Correctness

What it does

Requires that all @property tags have descriptions.

Why is this bad?

The description of a property should be documented.

Examples

Examples of incorrect code for this rule:

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

Examples of correct code for this rule:

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

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

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

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["jsdoc"],
  rules: {
    "jsdoc/require-property-description": "error",
  },
});

CLI

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

Version

This rule was added in v0.2.18.

References

• Rule Source
• Open rule in Oxc Playground