@use JSDoc

概述

@public 標籤表示應該將符號記錄為公開的。

預設情況下，JSDoc 將所有符號視為公開的，因此使用此標籤通常不會影響產生的文件。但是，您可能更喜歡明確使用 @public 標籤，以便讓其他人清楚您打算將符號公開。

在 JSDoc 3 中，@public 標籤不會影響符號的範圍。使用 @instance、@static 和 @global 標籤來變更符號的範圍。

範例

使用 @public 標籤
/**
 * The Thingy class is available to all.
 * @public
 * @class
 */
function Thingy() {
    /**
     * The Thingy~foo member. Note that 'foo' is still an inner member
     * of 'Thingy', in spite of the @public tag.
     * @public
     */
    var foo = 0;
}