利用jsdoc爲vue項目生成漂亮的文檔

jsdoc是前端自動生成文檔所經常使用的工具。咱們只要按照jsdoc的語法來書寫註釋就能順利的生成一片很漂亮的文檔。

只是jsdoc針對的是js文件，對於.vue文件彷佛就有些無能爲力了。不過既然vue這麼人氣，相信必定也會有相應的工具。在找了一圈以後，果真找到了一位前輩寫的jsdoc-vue。

在研究了一下以後，發現這個工具主要解決了jsdoc不認.vue文件的問題。雖然可讓.vue文件自動生成文檔，但生成出的文檔樣式卻並很差看。因而就fork過來改造了一下。

廢話很少說，先上一張生成的文檔截圖。 github地址：jsdoc-vue 改造版

改造的部分主要有如下幾點：

1. 使用了jsdoc字典，所以可使用jsdoc自帶的標籤來進行編寫。這樣也便於生成須要的模板。
2. 生成文檔採用了minami模板
3. 升級了 vue-template-complier 和 jsdoc 模塊

安裝使用方法

git clone git@github.com:Konata9/jsdoc-vue.git

npm install 
複製代碼

這個改造後的版本我本身用着還算比較滿意，比較重要的如props和components組件均可以利用jsdoc自帶的語法比較清楚的表示出來。

若是各位喜歡的話，但願能夠點一個star。固然，若是有改進的地方也但願各位能夠指點一下。