如何使用JSDoc记录回调？

Question

给定一个将回调函数作为参数的Javascript函数:

var myFunction = function(onSuccess, onFailure) {...}

我如何记录onSuccess返回类型和参数？

Answer 1

在JSDoc 3.1及更高版本中,您可以使用new @callback标记在单独的注释块中描述回调函数.然后,您可以在方法的文档中引用回调.

这是一个例子:

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

/**
 * Do something.
 * @param {MyClass~onSuccess} cb - Called on success.
 */
MyClass.prototype.myFunction = function(cb) {
    // code
};

/**
 * Callback used by myFunction.
 * @callback MyClass~onSuccess
 * @param {number} resultCode
 * @param {string} resultMessage
 */

有关更多信息,请参阅使用JSDoc.