@use JSDoc

同义词

语法

@description <some description>

概述

@description 标记允许您提供所记录符号的一般描述。描述中可以包含 HTML 标记。如果启用了 Markdown 插件，它还可以包含 Markdown 格式。

示例

如果您在 JSDoc 注释的开头描述一个符号，在使用任何块标记之前，您可以省略 @description 标记。

不使用 @description 标记描述符号
/**
 * Add two numbers.
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function add(a, b) {
    return a + b;
}

通过使用 @description 标记，您可以在 JSDoc 注释中的任何位置放置描述。

使用 @description 标记描述符号
/**
 * @param {number} a
 * @param {number} b
 * @returns {number}
 * @description Add two numbers.
 */
function add(a, b) {
    return a + b;
}

如果 JSDoc 注释的开头既有描述，又有通过 @description 标记提供的描述，则使用 @description 指定的描述将覆盖注释开头的描述。