jsdoc是前端自動生成文檔所常用的工具。我們只要按照jsdoc的語法來書寫注釋就能順利的生成一片很漂亮的文檔。
只是jsdoc針對的是js文件，對于.vue文件似乎就有些無能為力了。不過既然vue這么人氣，相信一定也會有相應(yīng)的工具。在找了一圈之后，果然找到了一位前輩寫的jsdoc-vue。
在研究了一下之后，發(fā)現(xiàn)這個工具主要解決了jsdoc不認(rèn).vue文件的問題。雖然可以讓.vue文件自動生成文檔，但生成出的文檔樣式卻并不好看。于是就fork過來改造了一下。
廢話不多說，先上一張生成的文檔截圖。
github地址：jsdoc-vue 改造版
vue文檔截圖.png
改造的部分主要有以下幾點(diǎn)：
- 使用了
jsdoc字典，因此可以使用jsdoc自帶的標(biāo)簽來進(jìn)行編寫。這樣也便于生成需要的模板。 - 生成文檔采用了minami模板
- 升級了 vue-template-complier 和 jsdoc 模塊
安裝使用方法
git clone git@github.com:Konata9/jsdoc-vue.git
npm install
這個改造后的版本我自己用著還算比較滿意，比較重要的如props和components組件都可以利用jsdoc自帶的語法比較清楚的表示出來。
如果各位喜歡的話，希望可以點(diǎn)一個star。當(dāng)然，如果有改進(jìn)的地方也希望各位可以指點(diǎn)一下。
