Possible Errors

Best Practices

Strict Mode

Variables

Node.js and CommonJS

Stylistic Issues

ECMAScript 6

valid-jsdoc

- Enforce valid JSDoc comments

Fixable

This rule enforces valid and consistent JSDoc comments. It reports any of the following problems:.

What ESLint should do when it catches the rule break

Show a warning

Options

requireReturnType

Disallows missing type in return tags.

requireParamDescription

Disallows missing description in parameter tags.

requireReturnDescription

Disallows missing description in return tags.

requireParamType

Disallows missing type in parameter tags.

requireReturn

Disallows missing type in parameter tags.

Specifies a regular expression to match the description in each JSDoc comment.

Rule examples

You can check them out here.