打字稿文档生成器

时间:2014-08-25 10:53:53

标签: javascript interface jsduck

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

这是我的输出,因为你可以看到该页面并不知道谁是 IComboBoxScope 当然,由于它没有生成java脚本

,因此它是可以理解的

http://i.stack.imgur.com/PIVKe.jpg

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

如果没有,是否有其他产品或解决方案用于记录带有打字稿的js?,maaybe jsDoc? ,typeDoc

对不起的样本/照片感到抱歉,我正在私人网络上工作。

2 个答案:

答案 0 :(得分:2)

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

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

输出example

我已经看到了改变主题的选项,类层次结构非常有效 由NPM安装并支持es 3,es 5 太棒了!

答案 1 :(得分:0)

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