AddTSDoctonestedparametersofafunctioncallbackin.d.ts

在 TypeScript 中，使用 TSDoc 可以很好地规范化代码的文档注释。而在函数回调中的嵌套参数中使用 TSDoc 却不太直观，需要一些技巧来正确书写。

假设有以下函数回调：

type Callback = (
  value: string,
  options: {
    isEnabled: boolean,
    count?: number,
    callback?: (updatedValue: string) => void
  }
) => void;

现在需要在 .d.ts 文件中为这个函数回调添加 TSDoc 注释。可以按照以下方式书写：

/**
 * @callback Callback
 * @param {string} value - The value.
 * @param {Object} options - The options.
 * @param {boolean} options.isEnabled - The flag to determine if the feature is enabled or not.
 * @param {number} [options.count] - The count of items.
 * @param {function} [options.callback] - The callback function to call. It accepts one parameter - the updated value.
 * @param {string} [options.callback.updatedValue] - The updated value.
 */

请注意，这里使用了 @callback 标记来表示这是一个回调函数类型。嵌套在 options 对象中的参数被拆分出来，并用方括号 [] 括起来来表示其是可选的。对于 callback 参数，它也是一个函数，并且它有一个参数 updatedValue。要表示 updatedValue 是回调函数的返回值，我们可以将其放在嵌套对象 callback 中。

最后，将定义的类型与回调函数类型合并即可：

interface MyInterface {
  myFunction(callback: Callback): void;
}

通过这样的方式，可以为嵌套参数的函数回调添加清晰的 TSDoc 注释。