只是jsdoc针对的是 js 文件,对于 .vue 文件似乎就有些无能为力了。不过既然 vue 这么人气,相信一定也会有相应的工具。在找了一圈之后,果然找到了一位前辈写的 jsdoc-vue 。
在研究了一下之后,发现这个工具主要解决了jsdoc不认 .vue 文件的问题。虽然可以让 .vue 文件自动生成文档,但生成出的文档样式却并不好看。于是就fork过来改造了一下。
废话不多说,先上一张生成的文档截图。
github地址: jsdoc-vue 改造版
这个改造后的版本我自己用着还算比较满意,比较重要的如 props 和 components 组件都可以利用jsdoc自带的语法比较清楚的表示出来。
如果各位喜欢的话,希望可以点一个star。当然,如果有改进的地方也希望各位可以指点一下。