[聚合文章] 利用jsdoc为vue项目生成漂亮的文档

JavaScript 1900-01-01 34 阅读

jsdoc是前端自动生成文档所常用的工具。我们只要按照jsdoc的语法来书写注释就能顺利的生成一片很漂亮的文档。

只是jsdoc针对的是js文件,对于.vue文件似乎就有些无能为力了。不过既然vue这么人气,相信一定也会有相应的工具。在找了一圈之后,果然找到了一位前辈写的jsdoc-vue

在研究了一下之后,发现这个工具主要解决了jsdoc不认.vue文件的问题。虽然可以让.vue文件自动生成文档,但生成出的文档样式却并不好看。于是就fork过来改造了一下。

废话不多说,先上一张生成的文档截图。
github地址:jsdoc-vue 改造版

注:本文内容来自互联网,旨在为开发者提供分享、交流的平台。如有涉及文章版权等事宜,请你联系站长进行处理。