给定一个将回调函数作为参数的Javascript函数:
var myFunction = function(onSuccess, onFailure) {...}
如何记录onSuccess
的返回类型和参数?
在 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。
此功能似乎尚不存在。
此功能是从 JSDoc 3.1 开始添加的。看:
- http://code.google.com/p/jsdoc-toolkit/issues/detail?id=319
- https://github.com/jsdoc3/jsdoc/issues/260
进行相关讨论。