5

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

/** 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 文档的工具？

4

4 回答 4

3

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

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

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

于 2018-12-07T11:32:20.557 回答
1

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

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

于 2013-05-20T00:13:06.570 回答
1

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

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

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

于 2013-09-26T16:06:25.793 回答
1

我发现了一个声称可以做到这一点的 npm 模块，尽管我还没有尝试过： https ://www.npmjs.org/package/tsdoc

于 2014-07-03T02:03:39.923 回答