购物车
登陆 / 注册
微信扫码登陆

@callback

@callback
@callback描述一个回调函数。@Callback标签提供回调函数(可传递给其他函数)的描述,包括回调的参数和返回值。你可以包涵任何一个你能提供给@method标签。
编辑:青灯夜游 青灯夜游 更新时间:2019-01-15 18:00:08

@callback

描述一个回调函数。

Syntax(语法)

@callback <namepath>

Overview(概述)

描述一个回调函数。@Callback标签提供回调函数(可传递给其他函数)的描述,包括回调的参数和返回值。你可以包涵任何一个你能提供给@method标签。

一旦你定义了一个回调,你可以像@typedef 标签所定义的自定义类型那样使用它。尤其是,你可以使用回调的名称作为类型名称。这样您可以使你明确指明函数参数应包含那个回调。

如果你想要一个回调显示为某个特定类的类型定义,可以给回调加一个namepath,指示它是某个类的一个内部函数。您还可以定义一个引用多个类引用的全局的回调类型。

Examples(例子)

例如,描述一个指定类回调:

/**
 * @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
 */

例如,描述一个全局回调:

/**
 * @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
 */
网站导航
网站首页
学习路径
视频教程
开发软件
旗下子站
php中文网
phpstudy
文章列表
教程文档
关于我们
企业合作
人才招聘
联系我们
讲师招募
QQ交流群
QQ交流群
微信公众号
微信公众号