语法
使用 JSDoc 标记词典(默认启用)
@protected
使用 Closure 编译器 标记词典
@protected [{typeExpression}]
概述
@protected
标记将符号标记为受保护的。通常,此标记表示符号仅在当前模块中可用或仅应在当前模块中使用。
默认情况下,用 @protected
标记标记的符号将显示在文档中。在 JSDoc 3.3.0 及更高版本中,可以使用 -a/--access
命令行选项 来更改此行为。
@protected
标记等同于 @access protected
。
示例
在以下示例中,实例成员 Thingy#_bar
出现在生成的文档中,但带有注释,表示它是受保护的