如何从TypeScript引用JavaScript jsDoc注释?

时间:2018-03-03 03:33:41

标签: typescript webstorm jsdoc

我有一个大型的Node.js库,其中包含jsDoc条评论的所有内容。我有一个.d.ts文件,其中包含所有相应的声明。

当我使用像WebStorm这样的编辑器时,它不会向我显示方法和类型的任何文档,因为它不在TypeScript声明文件中。

是否有可能修改每个方法的TypeScript文件并键入以自动引用包含文档的源JavaScript中的jsDoc

这样的东西? -

/**
* @jsdoc-reference ../src/person.js#L105
*/
findPerson(name: string):Person

我无法将所有jsDoc文档从源JavaScript复制到TypeScript声明中,这太过分了。

或者,是否有任何工具可以让我们获取.d.ts文件,并从中生成一个新的TypeScript文件,该文件会根据某种类型的自动修改jsDoc条评论参考源文件中的文档?

更新

从我到目前为止所发现的,没有解决方案,所以我开始草绘我自己的一个:docref

0 个答案:

没有答案