@constructs

Оглавление

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

Обзор

При использовании объектной записи для определения класса (например, с помощью тега @lends) тег @constructs позволяет документировать, что определённая функция будет использоваться для создания экземпляров этого класса.

Синтаксис

@constructs [<name>]

Примеры

var Person = makeClass(
    /** @lends Person.prototype */
    {
        /** @constructs */
        initialize: function(name) {
            this.name = name;
        },
        /** Describe me. */
        say: function(message) {
            return this.name + " says: " + message;
        }
    }
);

makeClass('Menu',
    /**
     * @constructs Menu
     * @param items
     */
    function (items) { },
    {
        /** @memberof Menu# */
        show: function(){
        }
    }
);

Связанные ссылки

@lends