JQuery API Doc generator可以生成typescript自定义Widget的API文档吗？

Question

3

我有一些自定义的 TypeScript Widget 需要创建 API 文档。我已经搜索了很多，但没有找到有用的东西。是否有任何工具可以生成类似 Jquery API 的 API 文档？

注意：我已经为我的 jQuery 自定义 Widget 使用了 Natural Docs，但我不能在 TypeScript 自定义 Widget 中使用它。是否有任何方法可以在 TypeScript 中使用它。

任何建议都将不胜感激...

- Karthi Keyan

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- MichaC · Answer 1

到目前为止，我认为 TypeScript 没有官方支持任何文档库的集成。

TypeScript 支持 jsdoc。这意味着您应该使用 jsdoc 风格的文档来编写 TypeScript。

我认为编译器也应该有一个选项，将您的 ts 注释添加到 js 文件中。这应该使您至少能够记录您的 JavaScript API，这基本上是其他人可能需要/使用来集成您的 API 的内容。