如何在类型记录TSDoc中描述函数的对象属性参数？

Question

如何在a和b中添加TSDoc描述？当我在像fn({ a })这样的函数调用中的属性参数上悬停时，我想要显示描述。

// This does not work

/**
 * @param props
 * @param props.a docs for a
 * @param props.b docs for b
 */
function fn({a, b}: {a: string, b: string}) {}


fn({ a })
//   ~
// Expecting hover info for `a`.

Answer 1

这确实有效。

interface Params {
  /** Desc for a */
  a?:string;
  b?:string;
}

/**
 * Desc for fn
 */
function fn({a, b}: Params) {}