如何为类型化的 object function 参数的字段执行 Typescript JSDoc？

Question

Below is a Typescript function signature x and it accepts ABC as optional parameter. If pass in ABC, a and b are the required fields.

async x (options: ABC = {}): Promise<string> 

interface ABC {
  a: string
  b: number
}

Should the JSDOC look like this

 /** 
   * @param {ABC} [options]
   * @param {string} options.a
   * @param {number} options.b
   * @return {Promise<string>} 
   */

Or this

 /** 
   * @param {ABC} [options]
   * @param {string} [options.a]
   * @param {number} [options.b]
   * @return {Promise<string>} 
   */

Answer 1

Document the structure of ABC in the JSDoc for ABC not in the JSDoc for x :

interface ABC {
    /**
     * describe `a` here
     */
    a: string

    /**
     * describe `b` here
     */
    b: number
}

/**
 * @param {ABC} options
 * @return {Promise<string>}
 */
async function x (options: ABC): Promise<string> {
    // IOU a promise
}

If there is nothing to describe about ABC.a or ABC.b , the you can skip that JSDoc altogether. Typescript and your Typescript IDE already know that a is a string and b is a number from the interface definition. Your proposed JSDoc would be redundant even if it were correct (it is not).

The signature for x in the question produces an error, so I had to guess you intent. See my comment under the question.