javascript - 打字稿文档生成器

Question

我开始用 jsDuck 记录我的 java-script + typescript 网站我已经很好地记录了我的类，但我的问题是接口 - 它们不会从 ts 文件编译到 java-script。

这是我的输出，因为你可以看到页面不知道谁是IComboBoxScope 当然它是可以理解的，因为它没有生成到 java 脚本

在jsDuck中是否有解决此问题的正确方法？

如果没有，是否有其他产品或解决方案可以用 typescript 记录 js？，maaybe jsDoc？，类型文档？

抱歉，样本/照片不佳，我正在使用专用网络。

score 2 · Accepted Answer

只是想分享我的发现，我发现了一个很棒的解决方案typeDoc非常好，它不需要编译的 javascripts，它专用于 ts 文件、新解决方案、活动环境，很棒的是我只需要以项目库作为参数运行 1 行脚本。

typedoc --out path/to/documentation/ path/to/typescript/project/

我已经看到更改主题的选项，NPM 安装的类层次结构非常好，并且支持 es 3，es 5 很棒！

score 0 · Accepted Answer

从 JSDuck 方面来看，没有简单的解决方法，因为 JSDuck 没有接口的概念。您可能会将您的接口记录为 JSDuck 的抽象类，但实际上并不相同。你最好使用原生支持 TypeScript 的工具。

2 回答 2