JSDoc 安裝教程

全域性安裝jsdoc最新版

npm install jsdoc -g

全域性安裝jsdoc 指定v3.6.3版本

npm install [email protected] -g

專案根目錄下新建conf.json檔案：

,

"recursedepth": 10,
"source": ,
"templates": ,
"opengraph": {},
"meta": {},
"recurse": true
}}

jsdoc -c conf.json -r

如需自定義模板，則需先安裝（這裡以docdash模板為例）

npm install docdash

,

"source": ,
"plugins": ["plugins/markdown"],
"opts": ,
"templates": 
},"docdash": }}
}

"script":

npm run generate-docs

jsdoc使用markdown外掛程式

原文 概覽 jsdoc包括markdown外掛程式，自動把markdown formatted文字轉換成html。你可以使用這個外掛程式與任何jsdoc模板。在jsdoc3.2.2及以後，降價外掛程式使用了明顯的markdown解析器。注意 當您啟用markdown外掛程式，一定要包括在您的jsdo...

jsdoc塊和內聯標籤

原文 概覽 jsdoc支援兩種不同型別的標籤 塊標籤通常會提供有關您的 的詳細資訊，如函式接受的引數。行內標籤通常鏈結到檔案的其他部分，類似於html中的錨標記 塊標籤總是以符號 開頭。每塊標記後面必須跟乙個換行符，在jsdoc注釋中除了最後一塊標記。行內標籤也以符號開頭。然而，內聯標籤及其文字必須...

關於jsdoc3,yuidoc使用感受

之前領導推薦用的yuidoc，當時感覺上手很快，標籤也不是很多。後來說用jsdoc要換，感覺很緊迫，跟yuidoc一樣用node安裝，然後先按照原來yuidoc的注釋執行了一遍，根據目錄完全不對，因為發現jsoc也支援 class,method,param,return,extends，exampl...