JSDoc的使用

一、簡單介紹

        JSDoc是一個根據javascript文件中註釋信息，生成JavaScript應用程序或庫、模塊的API文檔 的工具。你能夠使用他記錄如：命名空間，類，方法，方法參數等。相似JavaDoc和PHPDoc。如今不少編輯器或IDE中還能夠經過JSDoc直接或使用插件生成智能提示。從而使開發者很容易瞭解整個類和其中的屬性和方法，而且快速知道如何使用，從而提升開發效率，下降維護成本。

二、做用

（1）、生成api文檔

（2）、生成智能提示

三、官方文檔

gitbook文檔：http://www.css88.com/doc/jsdoc/index.html

html5+聯盟：http://www.html5plus.org/doc/jsdocp.html#type_syntax

四、生成文檔

https://github.com/jsdoc3/jsdoc

npm install jsdoc -g

jsdoc yourJavaScriptFile.js