如何使用 JSDoc 记录回调？答案

【问题标题】：How to document callbacks using JSDoc?如何使用 JSDoc 记录回调？
【发布时间】：2012-11-04 10:17:12
【问题描述】：

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

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

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

【问题讨论】：

标签： jsdoc

【解决方案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。

【讨论】：

【解决方案2】：

~~好像还没有这个功能。~~

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