如何获取我的npm模块的JSdoc文档，以将功能显示在用户的VScode中？

Question

我是VScode和TypeScript的新手。我正在尝试向npm发布一个带有详细文档的小模块，并让用户的VScode安装在消耗我的精力时显示漂亮的类型定向指令。

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

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

但是，当我尝试导入自己的模块时，我似乎得到了 types ……但是将鼠标悬停在呼叫站点上时，我只会看到：

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

要使VScode（以及希望其他编辑器）内联显示，JavaScript文档注释有什么必要？也许与此相关，为什么VScode为我的功能说“别名”而不是“功能”或“方法”？

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';
}

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