Skip to content

jsdoc/empty-tags Restriction

What it does

Expects the following tags to be empty of any content:

  • @abstract
  • @async
  • @generator
  • @global
  • @hideconstructor
  • @ignore
  • @inner
  • @instance
  • @override
  • @readonly
  • @inheritDoc
  • @internal
  • @overload
  • @package
  • @private
  • @protected
  • @public
  • @static

Why is this bad?

The void tags should be empty.

Examples

Examples of incorrect code for this rule:

javascript
/** @async foo */

/** @private bar */

Examples of correct code for this rule:

javascript
/** @async */

/** @private */

References

Released under the MIT License.