如何使用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。

Answer 2

看來這個功能還不存在。

此功能中加入作爲JSDoc 3.1。請參閱：

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

了相關討論。