【问题标题】:Documentation Tool for TypeScript like JSDoc [closed]像 JSDoc 这样的 TypeScript 文档工具 [关闭]
【发布时间】:2014-07-31 17:24:15
【问题描述】:

Typescript 是否有任何工具可以从带注释的 cmets 自动生成文档?

我尝试将 JSDoc 与 TypeScript 一起使用。它在某种程度上起作用,但它们并不意味着一起工作。

有什么想法/建议吗?

【问题讨论】:

  • 你说得对,JSDoc 目前不能处理 TypeScript 文件,即使它们被编译为 JavaScript。 JSDoc issue #272 描述了一些兼容性问题。 TypeScript 支持不太可能很快实现。
  • @JeffWilliams 那篇文章是 2012 年的。你知道这方面最近有没有更新吗?他们support ECMAScript 6 classes now。但是,如果我编写一个 typescript 类,并且它编译为 ECMAScript 5,我会丢失“class”关键字。 :-(

标签: comments typescript documentation-generation jsdoc


【解决方案1】:

或者,有人创建了这个可能对你有用的http://functorial.com/typescript-docs/

【讨论】:

  • 截至 2016 年 12 月的死链接。
【解决方案2】:

据我所知——还没有!

但是,有 jsdoc 自己正在计划提供对 typescript 的支持。但是,不知道什么时候!

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2013-05-14
    • 1970-01-01
    • 2014-07-24
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2016-05-12
    • 2011-07-17
    相关资源
    最近更新 更多