Skip to main content

@name

Syntax

@name name

Overview

@name tells JSDoc the name to use for a symbol, overriding whatever JSDoc would infer. Use it when a symbol is dynamically assigned or when the inferred name is wrong.

Example

/**
* @name MyApp.utils.format
* @function
* @param {*} value
* @returns {string}
*/
(function () {
/* ... */
}());

See also

Official reference: jsdoc.app/tags-name