jsdoc使用markdown外掛程式

2021-07-05 08:24:30 字數 1194 閱讀 7593

原文:

概覽

jsdoc包括markdown外掛程式,自動把markdown-formatted文字轉換成html。你可以使用這個外掛程式與任何jsdoc模板。在jsdoc3.2.2及以後,降價外掛程式使用了明顯的markdown解析器。

注意:當您啟用markdown外掛程式,一定要包括在您的jsdoc注釋的每行起始的星號。如果省略前導星號,jsdoc的解析器可能會刪除星號,用於markdown格式化。

預設情況下,jsdoc查詢markdown格式的文字在以下jsdoc標籤:

啟用markdown外掛程式

要啟用markdown外掛程式,新增字串plugins/markdown到外掛程式陣列,在您的jsdoc配置檔案中:

配置檔案,使用markdown外掛程式

轉換markdown用額外的jsdoc標籤

預設情況下,markdown外掛程式只處理特定的jsdoc標籤為markdown文字。您可以通過新增乙個markdown.tags屬性設定為您jsdoc配置檔案來處理的其他標記markdown文字。該markdown.tags屬性包含額外的doclet屬性,可以包含markdown文字陣列。 (在大多數情況下,doclet屬性的名稱相同的標籤名。然而,一些標籤儲存方式不一樣;例如,@param 標籤儲存在的doclet的params屬性。如果你不知道如何標籤的文字儲存在乙個doclet中,執行jsdoc使用-x/–explain,列印每個的doclet到控制台)

例如,如果foo和bar標籤接受在乙個的doclet的foo和bar的屬性中儲存值,你可以使用markdown處理這些標籤,通過新增下面的設定到您jsdoc配置檔案:

轉換markdown用』foo』和』bar』標籤

}

剔除markdown處理的預設標籤

為了防止降價外掛程式處理任何預設jsdoc標籤,新增乙個markdown.excludetags屬性到您的jsdoc配置檔案。該markdown.excludetags屬性包含預設標籤的陣列,不應該對markdown文字處理。

例如,要從markdown處理排除author標籤:

剔除markdown處理的「author」標籤

}

JSDoc 安裝教程

全域性安裝jsdoc最新版 npm install jsdoc g 全域性安裝jsdoc 指定v3.6.3版本 npm install jsdoc 3.6.3 g 專案根目錄下新建conf.json檔案 recursedepth 10,source templates opengraph meta ...

markdown轉義 Markdown使用筆記

mrkdown使用筆記分享!要建立標題的話只需使用井號 開頭,井號的數量對應標題的級別。使用空行分隔文字即可實現段落效果。注意 段落開頭不要使用空格或者製表符 t即 tab 鍵 來縮排,否則可能會被當做 塊渲染 在段落前加 即可建立塊引用。這是塊引用 這是塊引用 這是塊引用 渲染效果 這是塊應用 這...

關於jsdoc3,yuidoc使用感受

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