@public
优质
小牛编辑
130浏览
2023-12-01
描述: 标记为公开的。
概述
@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; }