@use JSDoc

语法

@access <package|private|protected|public>

概述

@access 标记指定成员的访问级别。你可以将 @access 标记用作其他标记的同义词

除非使用 -p/--private 命令行选项运行 JSDoc,否则不会在生成的输出中显示私有成员。在 JSDoc 3.3.0 及更高版本中,你还可以使用 -a/--access 命令行选项 来更改此行为。

请注意,文档的访问级别不同于其范围。例如,如果 Parent 有一个名为 child 的内部变量,该变量被记录为 @public,则 child 变量仍将被视为具有名称路径 Parent~child 的内部变量。换句话说,child 变量将具有内部范围,即使该变量是公共的。要更改文档的范围,请使用 @instance@static@global 标记。

示例

将 @access 用作其他标记的同义词
/** @constructor */
function Thingy() {

    /** @access private */
    var foo = 0;

    /** @access protected */
    this._bar = 1;

    /** @access package */
    this.baz = 2;

    /** @access public */
    this.pez = 3;

}

// same as...

/** @constructor */
function OtherThingy() {

    /** @private */
    var foo = 0;

    /** @protected */
    this._bar = 1;

    /** @package */
    this.baz = 2;

    /** @public */
    this.pez = 3;

}