如何解决JSDoc-是否可以制作一个集成HTML文档?
我用JSDoc制作了Javascript API文档。 完成后,目录./docs生成了我精心制作的JSDoc文档所在的位置。
但是我认为,每个.js文件都有各种各样的文件,例如图标,脚本,样式,html文件...等。
是否有任何漂亮而简单的方法将这些文件制作为一个集成的html文件,例如Redoc,这是最好的API文档工具(对我而言:-D)?
解决方法
您可以使用来创建api文档
https://www.npmjs.com/package/swagger-jsdoc
它将接收所有包含jsdoc注释的JavaScript文件,并将其转换为通用的api文档。
唯一的警告是您的jsdoc设置需要支持swagger规范才能正常工作
这是jsdoc设置示例的入门
https://github.com/Surnet/swagger-jsdoc/blob/master/docs/GETTING-STARTED.md
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。