如何让我的 npm 模块的 JSdoc 文档显示在用户的 VScode 中？

Question

我对 VScode 和 TypeScript 有点陌生。我正在尝试向 npm 发布一个带有深入文档的小模块，并让用户的 VScode 安装在消耗我的努力时显示漂亮的类型导向指令。

当我尝试在 VScode 中输入 console.assert 时，我得到这样的结果：

酷！这就是我希望我的用户看到的！

然而，当我尝试导入我自己的模块时，我似乎得到了 types ......但是悬停在一个调用点上，我只看到：

明显缺乏……the carefully-detailed writeup I've published in the source-code中的任何一个。

JavaScript 文档注释有什么必要说服 VScode（希望还有其他编辑）将其内联显示？也许相关地，为什么 VScode 说 "alias" 而不是 "function" 或 "method" 我的功能？

Answer 1

要在将鼠标悬停在方法上时显示方法的文档，您必须将其包装在 JSDoc 格式的文档注释中。例如：

my_lib.ts:

/**
 * converts something to something
 * @param eldritch_horror This my argument
 * @returns the converted stuff.
 */
export function fromFakeUTF8String(eldritch_horror: string): string {
    return 'hello world';
}

现在，当您的用户导入它并将鼠标悬停在方法调用上时，他们将获得以下结果：

如何让我的 npm 模块的 JSdoc 文档显示在用户的 VScode 中？

How do I get my npm module's JSdoc documentation for functions to show up in users' VScode?

jsdoc

typescript

visual-studio-code