@use JSDoc

概述

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