jsdoc

使用jsdoc生成接口文件，方便查接口；

1. 制作一个.bat(windows系统使用)或者.sh(linux)的可执行文件。写入以下语句：

cd ..\项目所在文件夹
jsdoc -c jsdoc的json文件所在路径 . -r -d 输出路径

 

2. jsdoc文件内容(内容自行更改)：

 

3.写代码的时候，需要创建出命名空间(namespace)，类(class)。

/**
描述这个命名空间
@namespace ui
*/

 

/**
* 描述该文件
* @author 作者名
* @constructor
* @memberof ui
*/

 

/**
* 描述方法功能
@param {参数类型} [参数名] 参数意义 
*/

 

4. 执行可执行文件后，在输出路径的文件夹里找到index.html，就可查看效果了。

完事儿。