@description

描述: 描述一个标识.

别名:@desc

Syntax（语法）

@description <some description>

Overview（概述）

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

Examples（例子）

如果在注释开始的地方添加描述，那么可省略@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;
}