Skip to main content

@see

Syntax​

@see text
@see {@link namepath}

Overview​

@see adds a "See also" section pointing to related symbols or external resources. Multiple @see tags are allowed.

TypeScript Supported

TypeScript supports @see for linking to related symbols and external resources.

TypeScript docs →

Examples​

/**
 * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API MDN Fetch API}
 */
async function request(url) {}
/**
 * @see {@link parseCSV} for parsing
 * @see {@link serializeCSV} for serialising
 */
function processCSV(data) {}

See also​

Official reference: jsdoc.app/tags-see