TypeScript类型定义注释未在提示框显示问题求助

要让Status类型的各成员注释在hover组件status属性时正常显示，你需要给联合类型的每个字面量成员单独添加JSDoc注释，而非给整个Status类型加统一的块注释。

修改后的代码示例： #

/**
 * 组件状态枚举类型
 */
type Status = 
  /** 警告状态：用于提示需要关注的潜在风险或非严重问题 */
  'warning' | 
  /** 信息状态：用于展示中性的提示性内容，无风险提示 */
  'info' | 
  /** 错误状态：用于提示操作失败、系统错误等严重问题 */
  'error' | 
  /** 成功状态：用于提示操作完成、提交成功等正向反馈 */
  'success';

type MyComponentProps = {
  /**
   * 控制组件的状态样式与提示类型
   */
  status: Status;
}

原理说明： #

TypeScript语言服务只会识别联合类型中单个字面量成员的JSDoc注释，并在引用该类型的属性hover时，将这些成员注释展示出来。之前给整个Status类型加块注释的方式，仅会在hoverStatus类型本身时显示注释，无法传递到引用它的属性上。

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