JSDoc 中文网

语法

🌐 Syntax

@hideconstructor

概述

🌐 Overview

@hideconstructor 标签告诉 JSDoc 生成的文档不应显示类的构造函数。该标签在 JSDoc 3.5.0 及更高版本中可用。

🌐 The @hideconstructor tag tells JSDoc that the generated documentation should not display the constructor for a class. This tag is available in JSDoc 3.5.0 and later.

对于 ES2015 之前的类，将此标签与 @class 或 @constructor 标签 一起使用。

🌐 For pre-ES2015 classes, use this tag in combination with the @class or @constructor tag.

对于 ES2015 类，在构造函数的 JSDoc 注释中使用此标签。如果你的类没有显式构造函数，请在类的 JSDoc 注释中使用此标签。

🌐 For ES2015 classes, use this tag in the JSDoc comment for your constructor. If your class does not have an explicit constructor, use this tag in the JSDoc comment for the class.

示例

🌐 Examples

@hideconstructor 标签用于 ES2015 之前的类
/**
 * @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();
    }
}