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