windows 下怎样给你的extjs 项目生成前端api doc

生成工具：基于senchalib 的jsduck 一个ruby写的生成工具。

1. 在https://github.com/senchalabs/jsduck上面下载最新的jsduck.exe

2. 安装完成后在本地环境变量path上添加jsduck 的磁盘位置

3. cmd 下执行以下命令查看安装成功？jsduck --help

4. 生成js文档

执行命令

jsduck E:/src/ --builtin-classes --output e:/docs

其中，前面一个是源码所在目录

具体的可以通过 jsduck --help 查看更多配置参数

命令中“–”开头的为命令的参数，以下是一些常用的命令

• –builtin-classes：构建javascript语言内建类文档，如Array或Object类的使用说明。

• –output：文档输出所在目录。

• –encoding：编码默认为utf-8，如果js文件中包含了中文字符设置gbk即可。

• –welcome:为一个html文件的路径，文件中的内容会被解析出来放到文档的欢迎页显示。

• –eg-iframe：配置一个html文件路径，这个html文件用来配置@example范例的预览方式，如需要生成非ExtJs或者sencha touch项目的话通常都需要自定义配置。

• –images：如果文档中引入了图片需配置一个图片目录。

• –title：自定义文档的标题

• –footer：自定义文档脚注

• –help：full 显示帮助文档。