@callback

.. @callback::

语法

@callback <namepath>

概述

@callback 标记提供有关可以传递给其他函数的回调函数的信息, 包括回调的参数和返回值. 您可以包含可以为@method提供的任何标记.

定义回调后, 可以使用与使用@typedef标记定义的自定义类型相同的方式使用它. 特别是, 您可以将回调的名称用作类型名称. 这允许您指示函数参数应包含某种类型的回调.

如果希望使用特定类的类型定义显示回调, 则可以为回调提供一个名称路径, 指示它是该类的内部函数. 您还可以定义从多个类引用的全局回调类型.

示例

Documenting a class-specific callback

/**
 * @class
 */
function Requester() {}

/**
 * Send a request.
 * @param {Requester~requestCallback} cb - The callback that handles the response.
 */
Requester.prototype.send = function(cb) {
    // code
};

/**
 * This callback is displayed as part of the Requester class.
 * @callback Requester~requestCallback
 * @param {number} responseCode
 * @param {string} responseMessage
 */

Documenting a global callback

/**
 * @class
 */
function Requester() {}

/**
 * Send a request.
 * @param {requestCallback} cb - The callback that handles the response.
 */
Requester.prototype.send = function(cb) {
    // code
};

/**
 * This callback is displayed as a global member.
 * @callback requestCallback
 * @param {number} responseCode
 * @param {string} responseMessage
 */