JSDoc中文文档(@use JSDoc)

JSDoc @static 标签

目录

概述

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