jsdoc - 如何使用 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
 */

有关更多信息，请参阅使用 JSDoc。

Answer 2

似乎这个功能还不存在。

从 JSDoc 3.1 开始添加此功能。看：

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

进行相关讨论。