JSDoc @member 标签

目录

• Synonyms
• 语法
• 概述
• 示例

同义词

JSDoc @var 标签

语法

@member [<type>] [<name>]

概述

@member标签记录成员基本种类（kind），比如"class", "function", 或者 "constant"。一个成员可以任选地具有一个类型以及名称。

示例

/** @class */
function Data() {
    /** @member {Object} */
    this.point = {};
}

下面是使用@var的一个例子，@member的别名，来描述一个（虚拟）变量'foo'。

/**
 * A variable in the global namespace called 'foo'.
 * @var {number} foo
 */

上面的例子等价于：

/**
 * A variable in the global namespace called 'foo'.
 * @type {number}
 */
var foo;