@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();
    }
}