利用jsdoc為vue專案生成漂亮的文件

2021-09-11 12:59:42 字數 712 閱讀 7411

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

只是jsdoc針對的是js檔案,對於.vue檔案似乎就有些無能為力了。不過既然vue這麼人氣,相信一定也會有相應的工具。在找了一圈之後,果然找到了一位前輩寫的jsdoc-vue

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

改造的部分主要有以下幾點:

使用了jsdoc字典,因此可以使用jsdoc自帶的標籤來進行編寫。這樣也便於生成需要的模板。

生成文件採用了minami模板

公升級了 vue-template-complier 和 jsdoc 模組

安裝使用方法

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

npm install

複製**

這個改造後的版本我自己用著還算比較滿意,比較重要的如propscomponents元件都可以利用jsdoc自帶的語法比較清楚的表示出來。

利用vue cli建立Vue專案

配置參考 2.基於node.js,利用 npm映象安裝相關依賴。在cmd裡直接輸入 npm install g cnpm registry 回車,等待安裝.注意 確保npm版本大於等於3.0.0,否則後續安裝會出現問題 3.安裝全域性vue cli腳手架,用於幫助搭建所需的模板框架。在cmd裡 1 ...

vue命令列生成專案

vue.js 提供乙個官方的命令列介面工具,用於快速搭建大型單頁面應用程式。能夠為現代前端開發的工作流程,帶來持久強力的基礎架構。只需幾分鐘,就可以建立並執行乙個帶有 熱過載 儲存時 檢查以及可直接用於生產環境的構建配置 的專案 安裝 vue cli npm install global vue c...

Vue(利用Vue cli搭建大型專案)

1.先安裝好git和node.js npm install g cnpm registry 3.全域性安裝vue cli cnpm install vue cli g4.初始化,建立專案 vue1 按回車即可 vue init webpack vue15.進入建立好的資料夾vue1 cd vue1 ...