@member

Содержание

• Синонимы
• Синтаксис
• Обзор
• Примеры

Синонимы

@var

Синтаксис

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

Обзор

Тег @member идентифицирует любой член, у которого нет более специализированного типа, например, "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;