@use JSDoc

構文

@hideconstructor

概要

@hideconstructor タグは、生成されたドキュメントでクラスのコンストラクタを表示しないよう JSDoc に指示します。このタグは JSDoc 3.5.0 以降で使用できます。

ES2015 以前のクラスの場合、このタグを @class または @constructor タグ と組み合わせて使用します。

ES2015 クラスの場合、コンストラクタの JSDoc コメントでこのタグを使用します。クラスに明示的なコンストラクタがない場合は、クラスの JSDoc コメントでこのタグを使用します。

例

ES2015 以前のクラスを使用した @hideconstructor タグ
/**
 * @classdesc Toaster singleton.
 * @class
 * @hideconstructor
 */
var Toaster = (function() {
    var instance = null;

    function Toaster() {}

    /**
     * Toast an item.
     *
     * @alias toast
     * @memberof Toaster
     * @instance
     * @param {BreadyThing} item - The item to toast.
     * @return {Toast} A toasted bready thing.
     */
    Toaster.prototype.toast = function(item) {};

    return {
        /**
         * Get the Toaster instance.
         *
         * @alias Toaster.getInstance
         * @returns {Toaster} The Toaster instance.
         */
        getInstance: function() {
            if (instance === null) {
                instance = new Toaster();
                delete instance.constructor;
            }

            return instance;
        }
    };
})();
ES2015 クラスを使用した @hideconstructor タグ
/**
 * Waffle iron singleton.
 */
class WaffleIron {
    #instance = null;

    /**
     * Create the waffle iron.
     *
     * @hideconstructor
     */
    constructor() {
        if (#instance) {
            return #instance;
        }

        /**
         * Cook a waffle.
         *
         * @param {Batter} batter - The waffle batter.
         * @return {Waffle} The cooked waffle.
         */
        this.cook = function(batter) {};

        this.#instance = this;
    }

    /**
     * Get the WaffleIron instance.
     *
     * @return {WaffleIron} The WaffleIron instance.
     */
    getInstance() {
        return new WaffleIron();
    }
}