加载中...

@member


描述:记录一个成员。

别名:

  • var

语法

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

概述

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

例子

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

  1. /** @class */
  2. function Data() {
  3. /** @member {Object} */
  4. this.point = {};
  5. }

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

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

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

上面的例子等价于:

  1. /**
  2. * A variable in the global namespace called 'foo'.
  3. * @type {number}
  4. */
  5. var foo;

还没有评论.