@use JSDoc

概要

クラスの定義にオブジェクトリテラルを使用した場合(例えば@lendsタグを使用した場合)、@constructsタグを使用すると、特定の関数がそのクラスのインスタンスを構築するために使用されることをドキュメント化できます。

構文

@constructs [<name>]

@lendsと@constructsタグを使用する
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(){
        }
    }
);