無名関数によるクラス作りのための JSDoc テンプレート

jsdoc_test.js

// http://www.wakuworks.com/test/jsdoc/

/**
 * 名前空間の説明
 * @namespace
 */
var Namespace = Namespace || {};

/**
 * クラスの説明など
 * @constructor
 * @param {String} str 引数の説明
 */
var Namespace.Class = Namespace.Class || (function()
{
    /** @exports Class as Namespace.Class */

    var PRIVATE_CONSTANT = "private";
    var _str = "private";

    /** constructor */
    function Class(str)
    {
        this.str = str;
    }

    /**
     * 定数の説明
     * @constant
     * @type {String}
     */
    Class.PUBLIC_CONSTANT = "public";

    /**
     * クラスメソッドの説明
     * @param {Number} n 引数の説明
     * @returns {Number} 戻り値の説明
     */
    Class.method = function(n)
    {
        return n;
    };

    Class.prototype = {
        /**
         * インスタンス変数の説明
         * @type {String}
         */
        str: "",

        /**
         * インスタンス変数の説明
         * @type {String}
         * @private
         */
        _str: "",

        /**
         * インスタンスメソッドの説明
         * @param {Number} n 引数の説明
         * @returns {Number} 戻り値の説明
         */
        method: function(n)
        {
            return n;
        },

        /**
         * インスタンスメソッドの説明
         * @param {Number} n 引数の説明
         * @returns {Number} 戻り値の説明
         * @private
         */
        _method: function(n)
        {
            return n;
        }
    };

    return Class;
}
)();