JSDoc-是否可以制作一个集成HTML文档?

时间:2020-08-28 02:16:48

标签: javascript documentation jsdoc

我用JSDoc制作了Javascript API文档。 完成后,目录./docs生成了我精心制作的JSDoc文档所在的位置。

但是我认为,每个.js文件都有各种各样的文件,例如图标,脚本,样式,html文件...等。

是否有任何漂亮而简单的方法将这些文件制作为一个集成的html文件,例如Redoc,这是最好的API文档工具(对我而言:-D)?

1 个答案:

答案 0 :(得分:0)

您可以使用来创建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