如何使用JSDoc记录回调？

Question

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

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

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

Answer 1

在JSDoc 3.1及更高版本中，您可以使用新的@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
 */

有关详细信息，请参阅Use JSDoc。

Answer 2

似乎此功能尚不存在。

此功能自JSDoc 3.1起添加。参见：

• http://code.google.com/p/jsdoc-toolkit/issues/detail?id=319
• https://github.com/jsdoc3/jsdoc/issues/260

进行相关讨论。