Why this matters
Improves IntelliSense, cross-language usage, and code navigation.
All exported JS/TS functions, classes, and public members must include JSDoc with a summary and @param/@returns; include @throws when applicable.
Improves IntelliSense, cross-language usage, and code navigation.
Side-by-side examples engineers can pattern-match during review.
export function sum(a, b) { return a + b }/
* Add two numbers.
* @param {number} a First addend.
* @param {number} b Second addend.
* @returns {number} a + b
/
export function sum(a, b) { return a + b }/* Multiply two numbers. @param {number} x @param {number} y @returns {number} /
export const mul = (x, y) => x * y;export const mul = (x, y) => x * y;From the same buckets as this rule.