如何使用 js 文档描述具有类型的接口方法？答案

【问题标题】：How to describe interface method with a type using js docs?如何使用 js 文档描述具有类型的接口方法？
【发布时间】：2022-12-24 23:32:21
【问题描述】：

我有以下代码：

/**
 * @interface an interface for Foo
 */
interface IFoo {
  init: () => void;
}

class Foo implements IFoo {
  public init(): void {}
}

我想用一种类型来描述 init 方法，就像我对任何其他参数 @param {type} name - description 所做的那样，但是 @param 对于方法描述来说似乎不是一件好事，并且 @method 无法正确显示类型, 尝试后

 * @method {() => void} init - method for initialization

我得到这样的描述：

是否有一种正确的方法来描述带有类型的接口方法？

【问题讨论】：

【解决方案1】：

您可以省略 @ 标签并在方法或/和接口上方的注释中放置描述

/**
 * An interface for Foo
 */
interface IFoo {
  /**
   * method for initialization
   */
  init: () => void;
}

【讨论】：