如何使用JSDoc定义带描述映射的字符串字面量联合类型

绝对可以实现你的需求！TypeScript（以及VS Code内置的TypeScript语言服务）支持给联合类型中的每个字符串字面量单独添加JSDoc注释，这样在使用该类型时，智能提示就会同步显示对应的描述文本。

你只需要把每个状态字符的说明直接注释在对应字面量的上方即可，具体写法如下：

/**
 * 任务状态类型定义
 */
export type Status = 
  /** Not Started - 未开始 */
  "N" | 
  /** In Progress - 进行中 */
  "P" | 
  /** Done - 已完成 */
  "D" | 
  /** Accepted - 已验收 */
  "A" | 
  /** Released - 已发布 */
  "R";

修改完成后，当你在VS Code中使用Status类型时，比如声明变量：

const taskStatus: Status = "";

将光标置于引号内，VS Code的智能提示就会列出所有可选的状态字符，每个字符旁都会显示你添加的JSDoc描述，完美匹配你想要的效果。

这种写法是TypeScript官方认可的标准JSDoc用法，不需要额外配置VS Code，只要你的项目启用了TypeScript语言服务（这是VS Code的默认配置）就能直接生效。

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