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