语法
@access <package|private|protected|public>
概述
@access
标记指定成员的访问级别。你可以将 @access
标记用作其他标记的同义词
@access package
与@package
相同。此选项在 JSDoc 3.5.0 及更高版本中可用。@access private
与@private
相同。@access protected
与@protected
相同。@access public
与@public
相同。
除非使用 -p/--private
命令行选项运行 JSDoc,否则不会在生成的输出中显示私有成员。在 JSDoc 3.3.0 及更高版本中,你还可以使用 -a/--access
命令行选项 来更改此行为。
请注意,文档的访问级别不同于其范围。例如,如果 Parent
有一个名为 child
的内部变量,该变量被记录为 @public
,则 child
变量仍将被视为具有名称路径 Parent~child
的内部变量。换句话说,child
变量将具有内部范围,即使该变量是公共的。要更改文档的范围,请使用 @instance
、@static
和 @global
标记。