@use JSDoc

語法

@access <package|private|protected|public>

概述

@access 標籤指定成員的存取層級。您可以將 @access 標籤用作其他標籤的同義詞

除非使用 -p/--private 命令列選項執行 JSDoc,否則不會在產生的輸出中顯示私有成員。在 JSDoc 3.3.0 及後續版本中,您也可以使用 -a/--access 命令列選項 來變更此行為。

請注意,文件說明的存取層級與其範圍不同。例如,如果 Parent 有個內部變數名為 child,且文件說明為 @public,則 child 變數仍會被視為具有名稱路徑 Parent~child 的內部變數。換句話說,即使變數是公開的,child 變數仍會有內部範圍。若要變更文件說明的範圍,請使用 @instance@static@global 標籤。

範例

將 @access 用作其他標籤的同義詞
/** @constructor */
function Thingy() {

    /** @access private */
    var foo = 0;

    /** @access protected */
    this._bar = 1;

    /** @access package */
    this.baz = 2;

    /** @access public */
    this.pez = 3;

}

// same as...

/** @constructor */
function OtherThingy() {

    /** @private */
    var foo = 0;

    /** @protected */
    this._bar = 1;

    /** @package */
    this.baz = 2;

    /** @public */
    this.pez = 3;

}