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