如何在 typescript TSDoc 中描述 function 的 object 属性参数？

Question

How do I add descriptions for a and b in TSDoc? I want the description be shown when I hover on a property argument in a function call like 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

This does works

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

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