typedoc/jsdoc 文档通用参数（回调参数）

【问题标题】：typedoc/jsdoc document generic parameter (callback arguments)typedoc/jsdoc 文档通用参数（回调参数）
【发布时间】：2018-06-23 12:58:31
【问题描述】：

我有以下代码：

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

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

有什么想法吗？

【问题讨论】：

【解决方案1】：

如果您只需要一个悬挂普通 JSDocs 的地方，您可以创建另一种类型：

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

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

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

【讨论】：