1.
安裝JS Duck3
tar.gz版本
https://nodeload.github.com/senchalabs/jsduck/tarball/master
exe版本
http://cloud.github.com/downloads/senchalabs/jsduck/jsduck-3.7.0.exe
Windows 用户下载exe版本即可;
exe版本 jsduck-3.7.0.exe 重命名为 jsduck.exe, 加入环境变量PATH中。
2.
介绍
Sencha JavaScript 框架的API 文档生成器。
JsDuck 用于生成 Ext JS 4 , Sencha Touch 和其它产品的API文档.
3.
用法:
3.1 直接生成原生类文档
jsduck --builtin-classes --output ./docs
3.2 生成ExtJS源代码API文档
- jsduck ext-4.1.0-beta-3/src \ --builtin-classes \ --p_w_picpaths ext-4.1.0-beta-3/docs/p_w_picpaths \ --output ./jsduck/docs
3.3 生成工程文档
- jsduck ext-4.1.0-beta-3/src / E:/bisoft/code/workspace/project/src/main/webapp/js --builtin-classes / --p_w_picpaths ext-4.1.0-beta-3/docs/p_w_picpaths / --output ./jsduck/xdocs
4.
高级用法:
https://github.com/senchalabs/jsduck/wiki/Advanced-Usage
5、实例
3.4版本的api制作如下:
下载3.4版本的所有内容,解压后执行:
jsduck ext-3.4.0/src --builtin-classes --p_w_picpaths ext-3.4.0/docs/p_w_picpaths --output ./jsduck/docs
【注意】
1、先创建文件jsduck/docs, 再执行上面命令。执行中有一堆警告,直接忽略