如何为TypeScript .d.ts类型声明文件添加内容描述注释

你只需要在.d.ts文件的对应类型、方法、属性定义上方添加JSDoc格式的块级注释即可实现预期的提示效果，具体操作如下：

• 必须使用/** */包裹注释内容，不要使用//单行注释，后者不会被TypeScript识别为智能提示文本
• 可以配合@param、@example、@returns等JSDoc标签丰富提示内容，编辑器会自动格式化展示
• 事件类型的注释可以直接写在事件映射接口的对应属性上方，也可以写在事件方法的重载定义上方

示例代码 #

// 事件映射定义示例
interface CustomEventMap {
  /** 节点选中状态变化时触发，返回当前选中的节点ID集合 */
  selectionChange: (selectedIds: string[]) => void;
  /** 数据加载完成后触发，返回全量数据对象 */
  loadComplete: (data: Record<string, any>) => void;
}

// 事件方法定义示例
declare class Emitter {
  /**
   * 绑定事件监听函数
   * @param eventName 目标事件名称，可选值参考CustomEventMap定义
   * @param listener 事件触发时执行的回调函数
   * @example
   * ```ts
   * emitter.on('selectionChange', (ids) => {
   *   console.log('当前选中节点：', ids)
   * })
   * ```
   */
  on<T extends keyof CustomEventMap>(eventName: T, listener: CustomEventMap[T]): void;

  /**
   * 触发指定事件
   * @param eventName 要触发的事件名称
   * @param args 传递给回调函数的参数列表
   */
  emit<T extends keyof CustomEventMap>(eventName: T, ...args: Parameters<CustomEventMap[T]>): void;
}

完成定义后，确保你库的package.json中types字段正确指向你编写的.d.ts入口文件，安装该库的项目在编辑器中调用相关方法、选择事件名称时，就会自动弹出你填写的注释提示。

内容的提问来源于stack exchange，提问作者DevineDecrypter