JSDoc使用指南


1.JSDoc安裝和配置:

JSDoc安裝:使用npm安裝npm install jsdoc –g

JSDoc配置:進入JSDoc的安裝目錄找到並修改 conf.json.EXAMPLE進行自定義配置,也可以不做修改使用默認配置

2.JSDoc注釋文檔編輯:

格式:  /**

                   * @標簽 文檔內容

                   */

常用功能標簽:

           desc/description 描述方法、變量,放在第一排可省略

           method/function   方法名

           param    參數,可定義類型

           property    屬性,可定義類型

           return  方法返回值,可定義類型

           todo 描述函數的功能

           global   表示變量是否是全局

           constructs 表明是構造函數

           default  默認值

           alias  別名

           event  事件

           example  示例

           type   變量類型

           module   標明當前文檔模塊

文檔信息標簽

           version   版本信息

           author   作者

           license   開源協議

           link   鏈接

3.生成文檔文件

使用cmd進入當前項目文件,輸入命令:jsdoc 文件相對路徑.js

(注意,默認配置下,輸入文檔必須是js類型不能是html類型)

回車后,在當前項目文件根目錄下會生成一個out文件夾,里面有3個文件夾fonts、scripts、styles分別是生成文檔的字體、腳本和css樣式,根目錄下的html文檔文件就是JSDoc文檔。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM