> JSDoc在线手册 > @constructs

@constructs


描述: 这个函数成员将成为类的构造函数。

Overview(概述)

当使用对象字面量形式定义类(例如使用@lends标签)时,可使用@constructs标签标明这个函数用来作为类的构造实例。

Syntax(语法)

@constructs [<name>]

Examples(例子)

例如, @constructs 和 @lends 结合使用:

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

不和@lends结合使用的时候,你必须提供一个类的名称:

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

上一篇:
下一篇: