構文
JSDocタグ辞書がある場合 (デフォルトで有効)
@protected
Closure Compilerタグ辞書がある場合
@protected [{typeExpression}]
概要
@protectedタグはシンボルをprotectedとしてマークします。通常、このタグはシンボルが利用可能であることを示すか、現在のモジュール内でのみ使用される必要があることを示します。
デフォルトでは、@protectedタグでマークされたシンボルはドキュメントに表示されます。JSDoc 3.3.0以降では、-a/--accessコマンドラインオプションを使用してこの動作を変更できます。
@protectedタグは@access protectedと同等です。
例
次の例では、インスタンスメンバーのThingy#_barが生成されたドキュメントに表示されますが、「protected」であることを示す注釈とともに表示されます。
/** @constructor */
function Thingy() {
/** @protected */
this._bar = 1;
}