在TypeScript接口上从JSDoc生成文档的工具

Question

我有一个.d.ts文件，其中包含描述我的库的接口。 它有JSDoc注释，当人们在代码中引用.d.ts时，它将通过Visual Studio中的intellisense显示：

/** Description of JSNLogAppender */
interface JSNLogAppender {
    /* Description of setOptions */
    setOptions(options: JSNLogAppenderOptions): void;

    /* Description of log */
    log(logItem: JSNLogItem): void;
}

... etc ...

我需要基于JSDoc和TypeScript接口生成文档。 问题是我发现的所有生成器都使用JavaScript，并且接口不会编译为JavaScript。 我可以将JSDoc放在实现接口的实际类和函数上，但是当人们引用.d.ts文件时，我会丢失智能感知。

是否有一个工具可以从.d.ts文件中的JSDoc注释和TypeScript接口定义生成html文档？

Answer 1

目前没有。 在这里找不到任何相关的功能请求： http ： //typescript.codeplex.com/workitem/list/basic

我们目前所拥有的只是TypeScript语言服务理解JSDoc： http ： //typescript.codeplex.com/workitem/178

Answer 2

我写过这个可能有用的小工具： typescript-docs

您需要安装Haskell平台来构建它。

它对jsdoc样式的注释有基本支持，并将生成带有类型之间超链接的HTML，可能跨模块。

Answer 3

我找到了一个npm模块声称要做到这一点，虽然我还没有尝试过： https ： //www.npmjs.org/package/tsdoc

Answer 4

你可以使用http://typedoc.org/

它支持jsdoc无法推断的事情http://typedoc.org/guides/doccomments/

并且仍然会输出它无法识别的任何jsdoc描述符，这是幸运的。