如何使用JSDoc记录回调函数？

Question

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

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

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

- Gili

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

查看使用JSDoc获取更多信息。

- Jeff Williams

Answer 2

似乎这一功能尚不存在。

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

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

相关讨论，请参见上述链接。

- Gili