如何在JSDoc中将函数定义为回调实现

How to define a function to be a callback implementation in JSDoc?

本文关键字：定义 回调 实现 函数 JSDoc      更新时间：2023-09-26

我是这样定义@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) { // ...

我还没有测试过这个，但由于@callback只是定义了一个类型，难道不能使用@type声明吗？

换句话说：

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

请参阅http://usejsdoc.org/tags-type.html以获取关于CCD_ 6的进一步信息。

相关文章：