购物车
登陆 / 注册
微信扫码登陆

@access

@access
@access 指定该成员的访问级别(私有 private,公共 public,或保护 protected)
编辑:青灯夜游 青灯夜游 更新时间:2019-01-07 14:34:29

@access

指定该成员的访问级别(私有 private,公共 public,或保护 protected)

Syntax(语法)

@access <private|protected|public>

Overview(概述)

指定该成员的访问级别(私有 private,公共 public,或保护 protected)。你可以使用与@access标签同义的其他标签:

  • @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标签。

Examples(例子)

例如,可以使用与@access标签同义的其他标签:

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

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

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

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

}

// same as...

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

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

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

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

}
网站导航
网站首页
学习路径
视频教程
开发软件
旗下子站
php中文网
phpstudy
文章列表
教程文档
关于我们
企业合作
人才招聘
联系我们
讲师招募
QQ交流群
QQ交流群
微信公众号
微信公众号