javascript - JSDoc - 是否可以制作一个集成的 html 文档?
问题描述
我用 JSDoc 制作了我的 Javascript API 文档。制作完成后,在我精心制作的 JSDoc 文档所在的位置生成了 ./docs 目录。
但我认为,每个 .js 文件的图标、脚本、样式、html 文件......等文件种类繁多,种类繁多。
有没有任何漂亮简单的方法可以将这些文件制作成一个集成的 html 文件,比如Redoc,这是最好的 API 文档工具(对我来说 :-D)?
解决方案
您可以使用创建 api 文档
https://www.npmjs.com/package/swagger-jsdoc
它将接收所有包含 jsdoc 注释的 JavaScript 文件,并将它们转换为 swagger api 文档。
唯一需要注意的是,您的 jsdoc 设置需要支持 swagger 规范才能正常工作
这是 jsdoc 设置示例的入门
https://github.com/Surnet/swagger-jsdoc/blob/master/docs/GETTING-STARTED.md
推荐阅读
- c++ - RtMidiIn 在发行版 C++ 中找不到端口
- javascript - 为什么核心装饰器的自动绑定定义了两次绑定函数?
- c# - 如何解决,UIAlertController (ActionSheet) is Crashed on iPad in xamarin.ios native app?
- ide - 在 PhpStorm 滚动错误消息预览中更改颜色
- php - TCPDF如何禁用字体斜体?
- django - Django Rest Framework 中的哪些字段允许 POST 数据结合 FileField 和 IntegerField?
- c++ - 切换 NvAPI_Stereo_Deactivate/NvAPI_Stereo_activate 会使统一应用程序崩溃
- javascript - 淘汰赛:表选择取消选择行。取消选择行的问题/挑战
- c# - MVVM - 附加属性 selectionstart,文本框中的 selectionlength
- c - fread 不会读取整个文件