【问题标题】:typescript documentation generator打字稿文档生成器
【发布时间】:2014-08-25 10:53:53
【问题描述】:
我开始用 jsDuck 记录我的 java-script + typescript 网站
我已经很好地记录了我的课程,但我的问题是接口 - 它们不会从 ts 文件编译到 java 脚本。
这是我的输出,你可以看到页面不知道谁是 IComboBoxScope
当然这是可以理解的,因为它不会生成到 java 脚本中
http://i.stack.imgur.com/PIVKe.jpg
jsDuck 中是否有解决此问题的正确方法?
如果没有,是否有其他产品或解决方案可以用 typescript 记录 js?,maaybe jsDoc? ,typeDoc?
抱歉,样本/照片不佳,我正在使用专用网络。
【问题讨论】:
标签:
javascript
interface
jsduck
【解决方案1】:
只是想分享我的发现,
我找到了一个很好的解决方案typeDoc 真的很好,它不需要编译的 javascripts,它专用于 ts 文件,
新的解决方案,活跃的环境,最棒的是我只需要运行一个以项目库为参数的 1 行脚本。
typedoc --out path/to/documentation/ path/to/typescript/project/
输出example
我看到了更改主题的选项,类层次结构运行良好
由 NPM 安装并支持 es 3,es 5
太棒了!。
【解决方案2】:
从 JSDuck 方面来看,没有简单的解决方法,因为 JSDuck 没有接口的概念。您可能会将您的接口记录为 JSDuck 的抽象类,但实际上并不相同。你最好使用原生支持 TypeScript 的工具。