如何在JSDoc中定义一个函数作为回调实现?

时间:2014-09-08 14:59:55

标签: javascript jsdoc

我用这种方式定义了@callback

/**
 * @callback MyClass~Handler
 * @param {string} target
 * @param {Options} options - Original options
 */

我用它来定义我的类原型:

/**
 * @param {string} name - The name
 * @param {MyClass~Handler} handler
 * @private
 */
MyClass.prototype._builder = function(name, handler) { //...

但是如何告诉JSDoc以下函数与我的MyClass~Handler具有相同的定义(在下面的代码中类似于@isacallback)?

/**
 * Default handler
 * @isacallback {MyClass-Handler}
 * @private
 */
MyClass.prototype._defaultHandler = function(target, options) { // ...

1 个答案:

答案 0 :(得分:0)

我还没有对此进行测试,但由于@callback只定义了一种类型,您是否不能使用@type声明?

换句话说:

/**
 * Default handler
 * @type {MyClass-Handler}
 * @private
 */
MyClass.prototype._defaultHandler = function(target, options) { // ...

有关@type的详细信息,请参阅http://usejsdoc.org/tags-type.html