@use JSDoc

語法

使用 JSDoc 標籤字典（預設啟用）

@package

使用 Closure Compiler 標籤字典

@package [{typeExpression}]

概觀

@package 標籤將符號標記為封裝私有。通常，此標籤表示符號僅對與此符號的來源檔案位於同目錄中的程式碼可用。此標籤在 JSDoc 3.5.0 及後續版本中可用。

預設情況下，標記有 @package 標籤的符號將顯示在您的文件中。在 JSDoc 3.3.0 及後續版本中，您可以使用 -a/--access 命令列選項 來變更此行為。

@package 標籤等同於 @access package。

範例

在以下範例中，實例成員 Thingy#_bar 會顯示在產生的文件中，但會附註表示它是封裝私有的

使用 @package 標籤
/** @constructor */
function Thingy() {
    /** @package */
    this._bar = 1;
}