javascript - typedoc/jsdoc 文档通用参数(回调参数)

Question

我有以下代码:

type AlarmEvent = events.Event<(name: Alarm) => void>;

如您所见，事件类采用函数签名形式的通用参数，我想将其记录下来。

有什么想法吗？

Answer 1

如果您需要的只是一个挂起普通 JSDoc 的地方，您可以创建另一种类型:

type AlarmHandler = (name: Alarm) => void
type AlarmEvent = events.Event<AlarmHandler>

如果您需要它与 JSDoc 一起使用，您可以使用 the @callback tag在独立的 JSDoc 注释中完成这项工作:

/**
 * Handles alarm events
 * @callback
 * @param {Alarm} name The alarm that fired
*/