visual-studio-code - 如何使用 JSDoc 定义字符串文字联合类型

Question

我想写一些 JSDoc 注释（可能在将来）使 VS Code 能够使用这些信息。我查看了 JSDoc 示例，但没有找到涵盖我的特定用例的示例（请参见下面的代码）。我将在片段下方进一步解释这一点。

/**
 * N: Not Started
 * P: In Progress
 * D: Done
 * A: Accepted
 * R: Released
 */
export type Status = "N" | "P" | "D" | "A" | "R";

我希望的是为每个单个字符串定义一个到描述的映射。如果 JS Doc 提供了一种定义映射的好方法，VS Code 可以显示更好的智能感知数据。例如，如果我在使用 Status 类型定义的变量的可能值列表中看到“N”，我希望 VS Code 能够在其旁边显示“未启动”。JS Doc可以做到这一点吗？注意：我不是在问如何用 VS Code 做到这一点，因为我认为这是一个先有鸡还是先有蛋的问题——JS Doc 首先需要支持它，然后 VS Code 才能用它做任何事情。所以我首先想看看使用 JSDoc 的“正确”方法是什么。

标签： visual-studio-codejsdocjsdoc3