@use JSDoc

語法

使用 JSDoc 標籤字典(預設啟用)

@protected

使用 Closure Compiler 標籤字典

@protected [{typeExpression}]

概述

@protected 標籤將符號標記為受保護的。通常,此標籤表示符號僅在目前模組中可用,或僅應在其中使用。

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

@protected 標籤等同於 @access protected

範例

在以下範例中,實例成員 Thingy#_bar 會顯示在產生的文件中,但會加上註解表示它是受保護的

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