@use JSDoc

语法

使用 JSDoc 标记词典（默认启用）

@package

使用 Closure Compiler 标记词典

@package [{typeExpression}]

概述

@package 标记将符号标记为包私有。通常，此标记表示符号仅对与该符号的源文件位于同一目录中的代码可用。此标记在 JSDoc 3.5.0 及更高版本中可用。

默认情况下，用 @package 标记标记的符号将显示在文档中。在 JSDoc 3.3.0 及更高版本中，可以使用 -a/--access 命令行选项 来更改此行为。

@package 标记等效于 @access package。

示例

在以下示例中，实例成员 Thingy#_bar 出现在生成的文档中，但带有注释，表明它是包私有的

使用 @package 标记
/** @constructor */
function Thingy() {
    /** @package */
    this._bar = 1;
}