@use JSDoc

シノニム

構文

@member [<type>] [<name>]

概要

@memberタグは、「class」、「function」、「constant」といったより特殊化した種別を持たないあらゆるメンバーを識別します。メンバーには、名前だけでなく、任意で型を持たせることができます。

Data#pointで@memberを使用
/** @class */
function Data() {
    /** @member {Object} */
    this.point = {};
}

仮想変数「foo」をドキュメントするために、@memberのシノニムである@varを使用した例を次に示します。

仮想メンバーをドキュメントするために@varを使用
/**
 * A variable in the global namespace called 'foo'.
 * @var {number} foo
 */

上記の例は次と同等です。

/**
 * A variable in the global namespace called 'foo'.
 * @type {number}
 */
var foo;