jsdoc 是前端自动生成文档所常用的工具我们只要按照 jsdoc 的语法来书写注释就能顺利的生成一片很漂亮的文档
只是 jsdoc 针对的是 js 文件, 对于. vue 文件似乎就有些无能为力了不过既然 vue 这么人气, 相信一定也会有相应的工具在找了一圈之后, 果然找到了一位前辈写的 jsdoc-vue
在研究了一下之后, 发现这个工具主要解决了 jsdoc 不认. vue 文件的问题虽然可以让. vue 文件自动生成文档, 但生成出的文档样式却并不好看于是就 fork 过来改造了一下
废话不多说, 先上一张生成的文档截图
github 地址: jsdoc-vue 改造版
vue 文档截图. png
改造的部分主要有以下几点:
使用了 jsdoc 字典, 因此可以使用 jsdoc 自带的标签来进行编写这样也便于生成需要的模板
生成文档采用了 minami 模板
升级了 vue-template-complier 和 jsdoc 模块
安装使用方法
git clone git@github.com:Konata9/jsdoc-vue.git
npm install
这个改造后的版本我自己用着还算比较满意, 比较重要的如 props 和 components 组件都可以利用 jsdoc 自带的语法比较清楚的表示出来
如果各位喜欢的话, 希望可以点一个 star 当然, 如果有改进的地方也希望各位可以指点一下
来源: http://www.jianshu.com/p/d9ca1acd099c