@use JSDoc

語法

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

@private

使用 Closure Compiler 標籤字典

@private [{typeExpression}]

概觀

@private 標籤將符號標記為私有，或不供一般用途。除非使用 -p/--private 命令列選項執行 JSDoc，否則不會在產生的輸出中顯示私有成員。在 JSDoc 3.3.0 及更新版本中，您也可以使用 -a/--access 命令列選項 來變更此行為。

@private 標籤不會被子成員繼承。例如，如果將 @private 標籤新增至名稱空間，名稱空間的成員仍會出現在產生的輸出中；由於名稱空間是私有的，成員的名稱路徑不會包含名稱空間。

@private 標籤等同於 @access private。

範例

在以下範例中，Documents 和 Documents.Newspaper 會出現在產生的文件，但 Documents.Diary 卻不會。

使用 @private 標籤
/** @namespace */
var Documents = {
    /**
     * An ordinary newspaper.
     */
    Newspaper: 1,
    /**
     * My diary.
     * @private
     */
    Diary: 2
};