【问题标题】:JQuery API Doc generator for typescript custom Widget? [closed]用于打字稿自定义小部件的 JQuery API 文档生成器? [关闭]
【发布时间】:2013-09-17 17:28:04
【问题描述】:
我有一些自定义打字稿小部件必须为此创建一个 API 文档。我已经搜索了很多,但我没有找到任何有用的东西。
是否有任何工具可以生成像Jquery API这样的 API 文档
注意:我已将 Natural Docs 用于我的 jquery 自定义小部件,但我无法在 typescript 自定义小部件中使用它。有没有办法将它用于打字稿。
任何建议都值得赞赏....
【问题讨论】:
标签:
javascript
jquery
api
documentation
typescript
【解决方案1】:
到目前为止,我认为没有官方支持任何集成到 typescript 中的文档库。
Typescript 支持jsdoc。
这意味着你应该为你的打字稿使用 jsdoc 风格的文档。
我认为编译器还应该有一个选项来将你的 ts cmets 添加到 js 文件中。这应该使您至少能够记录您的 javascript API,这或多或少是其他人可能需要/使用来集成您的 API。