JSDoc使用指南
1.JSDoc安裝和配置：
JSDoc安裝：使用npm安裝npm install jsdoc –g
JSDoc配置：進(jìn)入JSDoc的安裝目錄找到并修改 conf.json.EXAMPLE``進(jìn)行自定義配置纯命，也可以不做修改使用默認(rèn)配置
2.JSDoc注釋文檔編輯：
格式： /**
* @標(biāo)簽 文檔內(nèi)容
*/
常用功能標(biāo)簽：
desc/description 描述方法漂羊、變量甸各，放在第一排可省略
method/function 方法名
param 參數(shù)马靠，可定義類型
property 屬性蛹锰，可定義類型
return 方法返回值薄坏，可定義類型
todo 描述函數(shù)的功能
global 表示變量是否是全局
constructs 表明是構(gòu)造函數(shù)
default 默認(rèn)值
alias 別名
event 事件
example 示例
type 變量類型
module 標(biāo)明當(dāng)前文檔模塊
文檔信息標(biāo)簽
version 版本信息
author 作者
license 開(kāi)源協(xié)議
link 鏈接
3.生成文檔文件
使用cmd進(jìn)入當(dāng)前項(xiàng)目文件迈倍，輸入命令：jsdoc 文件相對(duì)路徑.js
（注意追城，默認(rèn)配置下，輸入文檔必須是js類型不能是html類型）
回車后故觅，在當(dāng)前項(xiàng)目文件根目錄下會(huì)生成一個(gè)out文件夾厂庇，里面有3個(gè)文件夾fonts、scripts输吏、styles分別是生成文檔的字體权旷、腳本和css樣式,根目錄下的html文檔文件就是JSDoc文檔。
