JSDoc中文文档(@use JSDoc)

JSDoc @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;
}