JQuery API 文档生成器，用于打字稿自定义小部件

JQuery API Doc generator for typescript custom Widget?

本文关键字：自定义小部用于文档 API JQuery 更新时间：2023-09-26

我有一些自定义打字稿小部件必须为此创建一个API文档。我搜索了很多，但没有找到任何有用的东西。是否有任何工具可以生成像Jquery API这样的API文档

注意：我已经将Natural Docs用于我的jquery自定义小部件，但我不能在打字稿自定义小部件中使用它。有没有办法将其用于打字稿。

任何建议都应不胜感激。

到目前为止，

我认为没有官方支持任何集成到打字稿中的文档库。

Typescript 支持 jsdoc。这意味着您应该使用jsdoc样式文档作为打字稿。

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