@use JSDoc

概述

@static 标记表示符号包含在父级中,并且可以在不实例化父级的情况下访问。

使用 @static 标记将覆盖符号的默认范围,但有一个例外:全局范围中的符号将保持全局。

示例

以下示例与编写 “@function MyNamespace.myFunction” 并省略 @memberof 和 @static 标记的效果相同

在虚拟注释中使用 @static
/** @namespace MyNamespace */

/**
 * @function myFunction
 * @memberof MyNamespace
 * @static
 */

以下示例强制模块的内部成员被记录为静态成员

使用 @static 覆盖默认范围
/** @module Rollerskate */

/**
 * The 'wheel' variable is documented as Rollerskate.wheel
 * rather than Rollerskate~wheel.
 * @static
 */
var wheel = 1;