如何使用 JSDoc 定义字符串文字联合类型

问题描述

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

element.style.fontFamily = "Arial Black"
>> "Arial Black"
element.style.fontFamily
>> "\"Arial Black\""

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

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)