@this【this 参照】
@callback【コールバック関数】
@async【非同期関数】

@this【this 参照】

構文

@this 【名前パス】

@this {【型】} 

/**
 * @constructor
 * @param {*} ext 追加情報
 */
function ClassThis(ext) {
  setExt.call(this, ext);
  alert(this.ext);
}

/**
 * 追加情報設定
 * @param {*} ext 追加情報
 * @this ClassThis
 */
function setExt(ext) {
  this.ext = ext;
}

var obj = new ClassThis("EXT");

関連


@callback【コールバック関数】

メモ

  • 【コールバック名】の指定方法については、【型】の【名前空間】指定を参照

構文

@callback 【コールバック名】

/**
 * @constructor
 */
function ClassCallbackA() {
  /**
   * メソッド
   * @param {ClassCallbackA~CallbackInner} callback コールバック関数 (内部)
   */
  this.func = function(callback) { };
}

/**
 * コールバック関数の説明
 * @callback ClassCallbackA~CallbackInner
 * @param {number} num 引数1
 * @param {string} str 引数2
 */

/**
 * @constructor
 */
function ClassCallbackB() {
  /**
   * メソッド
   * @param {CallbackGlobal} callback コールバック関数 (グローバル)
   */
  this.func = function(callback) { };
}

/**
 * コールバック関数の説明
 * @callback CallbackGlobal
 * @param {number} num 引数1
 * @param {string} str 引数2
 */

関連


@async【非同期関数】

メモ

  • JSDoc 3.5.0 以降で有効
  • ECMAScript 2017 で定義されている async【非同期関数】が対象
    未使用の関数では使用しない
  • 省略時は自動認識

構文

@async

/**
 * 関数の説明 (@async 省略)
 */
async function funcAsyncA() { }

/**
 * 関数の説明
 * @async
 */
async function funcAsyncB() { }

/**
 * 関数の説明 (実体無し)
 * @async
 * @function funcAsyncC
 */

関連