konata9/jsdoc-vue

A jsdoc plugin that parses *.vue files.

jsdoc-vue

A jsdoc plugin that parses *.vue files.

利用 jsdoc 自动生成 .vue 文件的文档。

修改点

1. 使用了jsdoc字典，可以使用jsdoc自带的标签来进行编写
2. 生成文档采用了minami模板
3. 升级了 vue-template-complier 和 jsdoc 模块

安装

git clone [email protected]:Konata9/jsdoc-vue.git

npm install 

使用方法

jsdoc 参数可以参照官方文档 Command-line arguments to JSDoc

如果没有在全局安装 jsdoc 请手动指定 jsdoc 所在的目录

jsdoc -c ./conf.js -r

or

./node_modules/jsdoc -c ./config.js -r

全局的配置可以参考config.js文件 更多jsdoc配置文件的语法请参照官网Configuring JSDoc with a configuration file

使用模板

minami

生成文档样式

请下载项目后，查看example/doc/index.html文件

License

WTFPL