Jsdoc ((install)) -

is the industry-standard markup language for annotating and documenting JavaScript source code. By adding structured comments directly to your files, you can automatically generate professional HTML documentation, provide rich IntelliSense in modern IDEs like VS Code, and even enable robust type-checking without ever writing a single line of TypeScript. The Anatomy of a JSDoc Comment

: Describes the value returned by a function. is the industry-standard markup language for annotating and

To document complex codebases, you rely on specialized "tags" that start with the @ symbol. To document complex codebases, you rely on specialized

: Used within @typedef to define properties of an object. * * @param {number} a - The first number

/** * Sums two numbers together. * * @param {number} a - The first number. * @param {number} b - The second number. * @returns {number} The sum of a and b. */ function add(a, b) { return a + b; } Use code with caution.

: Provides a code snippet showing how to use the documented item.

: Explicitly declares the type of a variable or property.