Jsdoc的安裝及使用方法
jsdoc用於生成腳本文檔的自動化工具
一、 安裝
所有安裝方式基於node環境使用npm安裝，未安裝node環境的小伙伴可參考：https://www.cnblogs.com/bluedream2009/archive/2012/03/17/2402843.html
jsdoc安裝命令：
npm i jsdoc -g （全局安裝）
jsdoc ink-docstrap模板安裝命令：
在當前項目腳本目錄下執行此命令
npm install ink-docstrap（局部安裝）
jsdoc tui-jsdoc-template模板安裝命令：
在當前項目腳本目錄下執行此命令
npm i -D tui-jsdoc-template（局部安裝）
以上兩種模板任選其一，以下模板未驗證過：
二、 配置
放置在項目腳本根目錄下
jsdoc ink-docstrap配置文件：
jsdoc tui-jsdoc-template配置文件：
配置部分示例：
"source": {
"include": ["business","control","dialog","item","layer","lib","scene","sdk"], 需要遍歷的目錄
"exclude": ["business/gameProtocol.js","scene/out"], 不需要遍歷的目錄
"includePattern": ".+\\.(js|es)$"
}
基於現有項目的目錄配置
"opts": {
"template": "node_modules/tui-jsdoc-template", 文檔所使用的模板
"destination": "./docs_tui/" 文檔輸出目錄
}
配置修改，可參考
https://github.com/nhnent/tui.jsdoc-template
https://github.com/docstrap/docstrap
三、 使用jsdoc生成文檔
進入到項目腳本根目錄下，執行命令：
Jsdoc –c 配置名稱.json
輸入命令后，將按照配置文件中的配置項，相應生成，以上提供的兩個配置文件，均已配置默認輸出目錄，可自由更改
四、 Jsdoc注釋規范
注釋規范參考：
https://www.css88.com/doc/jsdoc/index.html
以下內容僅作為參考
| 工具 |
優點 |
缺點 |
| JSDoc3 |
提供了完整的模板開發、事件觸發等接口，使用非常靈活。 |
對代碼要求比較嚴格，學習曲線較高。 |
| YUIDoc |
不止支持JS語言，更加抽象，如果同時使用了 Ruby/PHP/Python等語言YUI都可以使用。 |
功能更加抽象，具體實現方面考慮不全。 |
| Dox |
輕量級、高度可定制化，兼容JSDoc3語法。 |
后期會有較多問題需要自己解決。 |
| Docco |
行間注釋方式，更注重實現過程的文檔 |
不太適合API注釋 |
| JSDuck |
代碼實時修改、語法靈活、支持MarkDown語法，支持查看源碼並且文檔可讀性較高，最主要的是上手非常快。 |
可定制化支持不足，略顯臃腫。 |
總結：
建議代碼中混合了es6的項目，jsdoc比較適合，在未使用es6的情況下，比較推薦jsduck
jsdoc的學習成本較高，小伙伴們可以根據自己實際情況選擇