@member (synonyms: @var)¶

.. @member::¶

同义词

@var

语法

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

概述

@member标记标识任何没有更专业类型的成员, 例如“class”, “function”或“constant”. 成员可以选择具有类型和名称.

示例

Using @member with Data#point¶

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

下面是使用@var(@member的同义词)来记录(虚拟)变量’foo’的示例.

Using @var to document a virtual member¶

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

以上示例等同于以下内容:

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

.. @var::¶