@constructs - JsDoc Toolkitを使う！

トップページ > ドックコメントの書き方 > タグリファレンス >

@constructs

@lendsタグが使われている場面で、@constructsタグは特定の関数がクラスコンストラクタであることを示します。

• http://code.google.com/p/jsdoc-toolkit/wiki/TagConstructs

構文

@constructs

例

var Person = makeClass(

    /**
        @lends Person.prototype
     */

    {

        /** @constructs */

        initialize: function(name) {
            this.name = name;
        },
        say: function(message) {
            return this.name + " says: " + message;
        }
    }
);

注意：このタグと@constructorタグや@classタグは一緒に使えません。クラスに関する記述は全て@constructsタグを含むドックコメント内で行わなければなりません。

関連項目

• @lendsタグ

---