JSDoc 中文网

语法

🌐 Syntax

@access <package|private|protected|public>

概述

🌐 Overview

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

🌐 The @access tag specifies the access level of a member. You can use the @access tag as a synonym for other tags:

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

🌐 Private members are not shown in the generated output unless JSDoc is run with the -p/--private command-line option. In JSDoc 3.3.0 and later, you can also use the -a/--access command-line option to change this behavior.

请注意，文档单元（doclet）的_访问级别_与其_作用域_不同。例如，如果 Parent 有一个名为 child 的内部变量，并且该变量被记录为 @public，child 变量仍然会被视为名称路径为 Parent~child 的内部变量。换句话说，child 变量将具有内部作用域，即使该变量是公开的。要更改文档单元的作用域，请使用 @instance、@static 和 @global 标签。

🌐 Note that a doclet's access level is different from its scope. For example, if Parent has an inner variable named child that is documented as @public, the child variable will still be treated as an inner variable with the namepath Parent~child. In other words, the child variable will have an inner scope, even though the variable is public. To change a doclet's scope, use the @instance, @static, and @global tags.

示例

🌐 Examples

将 @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;

}