JSDoc @access 标签
目录
语法
@access <package|private|protected|public>
概述
@access
标签指定该成员的访问级别(私有 private,公共 public,或保护 protected)。你可以使用与@access标签同义的其他标签:
@access package
等价于@package
. JSDoc 3.5.0 或更高版本可用.@access private
等价于@private
.@access protected
等价于@protected
.@access public
等价于@public
.
私有成员不会显示在生成的输出文档中,除非通过-p/--private
命令行选项运行JSDoc。在JSDoc3.3.0或更高版本,您还可以使用-a/--access
命令行选项来改变这种行为。
请注意,doclet的 访问级别
不用于他们的scope(作用域)。例如,如果Parent
有一个名为child
的内部变量,那么这个内部变量将被记录为@public
,child
变量仍然是被视为一个内部变量,其namepath为Parent~child
。
换一种说法,child
变量将有一个内部作用域,即使这个变量是公开的。 要更改doclet的作用域,请使用@instance
, @static
, 和 @global
标签。