Documentation comments triggered by @, so the tag names are one keystroke away instead of something to memorize.
Prefixes
Type variants extend the tag with a dot.@param.string, @property.array, @type.generic. Type @param. and the completion list lays out every shape.
Synonyms trigger the primary form. JSDoc documents @return, @desc, @emits, @virtual, @arg as alternative spellings. Typing any of them finds the snippet; what gets inserted is the primary tag — @returns, @description, @fires, @abstract, @param.
/// opens an empty block comment, in either dialect.
Common
Tags that apply to any symbol.
Prefix
Alias
Inserts
///
/** …
@description
@desc
@description description
@example
@example …
@deprecated
@deprecated since version X, use Y instead
@see
@see {@link OtherSymbol}}
@link
{@link namepath\|link text}
@since
@since 1.0.0
@version
@version 1.0.0
@todo
@todo description
@ignore
@ignore
@access
@access public
@license
/** …
Functions
The @param family covers the shapes you hit daily; the per-type variants save typing the brace.
Prefix
Alias
Inserts
@param
@arg, @argument
@param {TYPE} name - description
@param.optional
@param {TYPE} [name] - description
@param.default
@param {TYPE} [name=defaultValue] - description
@param.array
@param {Object[]} name - description
@param.generic
@param {Map<string, number>} name - description
@param.any
@param {*} name - description
@param.object
@param {Object} name - description
@param.string
@param {string} name - description
@param.number
@param {number} name - description
@param.boolean
@param {boolean} name - description
@param.function
@param {Function} name - description
@param.HTMLElement
@param {HTMLElement} name - description
@param.Node
@param {Node} name - description
@param.NodeList
@param {NodeList} name - description
@param.RegExp
@param {RegExp} name - description
@returns
@return
@returns {TYPE} description
@returns.promise
@returns {Promise<TYPE>} description
@throws
@exception
@throws {Error} description
@yields
@yield
@yields {TYPE} description
@async
@async
@this
@this {TYPE}
@requires
@requires moduleName
Types
@type takes a type expression only — the name comes from the declaration it sits above.
Prefix
Alias
Inserts
@type
@type {TYPE}
@type.any
@type {*}
@type.object
@type {Object}
@type.string
@type {string}
@type.number
@type {number}
@type.boolean
@type {boolean}
@type.function
@type {Function}
@type.HTMLElement
@type {HTMLElement}
@type.Node
@type {Node}
@type.NodeList
@type {NodeList}
@type.RegExp
@type {RegExp}
@type.array
@type {Object[]}
@type.generic
@type {Map<string, number>}
@typedef
@typedef {TYPE} Name
@typedef.object
/** …
@template
@template T
@callback
/** …
Object members
@property describes the members of an object or a @typedef.
Prefix
Alias
Inserts
@property
@prop
@property {TYPE} name - description
@property.optional
@property {TYPE} [name] - description
@property.array
@property {Object[]} name - description
@property.generic
@property {Map<string, number>} name - description
@property.any
@property {*} name - description
@property.object
@property {Object} name - description
@property.string
@property {string} name - description
@property.number
@property {number} name - description
@property.boolean
@property {boolean} name - description
@property.function
@property {Function} name - description
@property.HTMLElement
@property {HTMLElement} name - description
@property.Node
@property {Node} name - description
@property.NodeList
@property {NodeList} name - description
@property.RegExp
@property {RegExp} name - description
Classes
Prefix
Alias
Inserts
@class
@constructor
/** …
@extends
@augments
@extends {SuperClass}
@implements
@implements {Interface}
@interface
/** …
@abstract
@virtual
@abstract
@override
@override
@readonly
@readonly
@static
@static
Modules and events
Prefix
Alias
Inserts
@module
/** @module moduleName */
@external
@host
/** …
@fires
@emits
@fires EventName
@listens
@listens EventName
@file
@fileoverview, @overview
/** …
TSDoc
These appear in .ts and .tsx only. TSDoc carries no type annotations — types come from the signature — and the set below is the complete list of standard tags.
