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

见 Use JSDoc想要查询更多的信息。