JSDoc @description 标签

同义词

JSDoc @desc 标签

@description <some description>

@description标签允许您为符号(symbol)提供一般描述。该说明可能包括HTML标签。如果Markdown 插件启用的话，它也可包括Markdown格式。

如果在注释开始的地方添加描述，那么可省略@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标签指定的描述将会覆盖JSDoc注释开始的描述。