> JSDoc在线手册 > @member

@member


描述:记录一个成员。

别名:

  • var

语法

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

概述

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

例子

例如,Data#point上使用@member:

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

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

例如:使用@var来记录一个虚拟成员:

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

上面的例子等价于:

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

上一篇:
下一篇: