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

推荐手册

@public

@public
默认情况下,JSDoc把所有标识符当做公开的,因此使用这个标记一般不会影响生成的文档。 然而,你可能更愿意明确地使用 @public 标签,这样可以更加清晰的标明你要公开的标识符。
浅浅而谈 浅浅而谈 更新时间:2019-01-07 14:40:15

@public

描述: 标记为公开的。

概述

@public标签标记标识符为公开的。

默认情况下,JSDoc把所有标识符当做公开的,因此使用这个标记一般不会影响生成的文档。 然而,你可能更愿意明确地使用 @public 标签,这样可以更加清晰的标明你要公开的标识符。

在JSDoc 3中,@public标签不影响标识符的作用域。使用@instance, @static, 和 @global标签会改变标识符的作用域。

例子

使用 @public 标签:

/**
 * The Thingy class is available to all.
 * @public
 * @class
 */
 function Thingy() {
     /**
     * The Thingy~foo member. Note that 'foo' is still an inner member
     * of 'Thingy', in spite of the @public tag.
     * @public
     */    
     var foo = 0;
}
网站导航
标签地图
学习路径
视频教程
开发软件
旗下子站
php中文网
phpstudy
技术文章
文档工具
关于我们
企业合作
人才招聘
联系我们
讲师招募
QQ交流群
QQ官方交流群
微信公众号
微信公众号