@use JSDoc

概要

@global タグは、ドキュメントでシンボルがグローバルシンボルとして表示される必要があることを指定します。JSDoc はソースファイル内のシンボルの実際のスコープを無視します。このタグは、ローカルで定義され、その後グローバルシンボルに割り当てられたシンボルに特に便利です。

例

シンボルをグローバルとしてドキュメント化する場合、@global タグを使います。

内部変数をグローバルとしてドキュメント化
(function() {
    /** @global */
    var foo = 'hello foo';

    this.foo = foo;
}).apply(window);