JSDoc

Require JSDoc Body

Require a body paragraph in JSDoc blocks that explains why the declaration exists rather than restating the function or class name.

Require JSDoc summary lines to follow the hierarchy chain derived from the file path and method name for searchable documentation.

Require vertical alignment of param types, names, and dashes in JSDoc blocks so multi-parameter signatures stay visually consistent.

Require param descriptions in JSDoc blocks to match the parameter name with the first letter capitalized and a trailing period.

Require a leading JSDoc block on every documentable symbol so no class, function, method, or property ships undocumented.

Require a private tag in JSDoc blocks for private class members to keep documentation consistent with TypeScript access modifiers.

Require every @returns tag in JSDoc blocks to contain only a type in braces, with no trailing description after the type annotation.

Require a @since tag in every JSDoc block and validate its value as a semver version or UNRELEASED to track API introduction dates.

Require JSDoc tags to follow the canonical order with exactly one blank line between adjacent tag groups for consistent documentation.