JsDoc Toolkit 使用笔记

JsDoc Toolkit 是一款辅助工具，你只需要根据约定在 JavaScript 代码中添加相应的注释，它就可以根据这些注释来自动生成API文档。

下载地址:http://code.google.com/p/jsdoc-toolkit/

目录结构:

app : 存放的是js文件。包括一些实例文件和读取js和模板生成文档的js文件。

conf : 提供默认的配置的文件。

java : 存放的是“rhino”这是一个脚本java写的javascript脚本引擎，用来提供js的运行环境。

templates : 存放生成文档的模板，根据不同的模板可以生成html xml等各种类型文档。

jsrun.jar，jsdebug.jar : 生成的入口调用了rhino框架和js文件

用法

1.需要java环境支持：java -version

2.需要将当前目录切换到jsdoc-toolkit目录下，如D:\jsdoc_toolkit-2.4.0\jsdoc-toolkit

3.运行命令：

          java -jar jsrun.jar app/run.js -a -t=templates/jsdoc app/MyCode.js

MyCode.js为要生成文档的js文件,生成的文档文件在JsDoc目录下的out目录中