JsDoc Toolkit 是一款辅助工具，按照它的约定在Javascipt代码中添加对于的注释，会自动生成API文档。

 

用法：

 

   JsDoc Toolkit是用Java编写的，所以运行的时候需要Java环境。

 

   1、先去官网下载最新的压缩包（点击这里），解压之后进入jsdoc-toolkit目录（即jsrun.jar所在的目录），然后运行下面的命令：

 

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

 

    如果成功的话，当前的目录多了一个out的文件夹，生成的文档就在里面。

 

    更多高级的命令：

 

 

java -jar jsrun.jar app/run.js --help

 

     简单举例：

  •    -a       全部函数生成文档，包括没有写注释的
  •    -d=     指定生成文档的输出目录，默认是out
  •    -n       忽略所有代码，只有@name标签的注释生成文档
  •    -t=      指定文档的模版

 

标签简介：

 

   简单举例：

 

 

  • @author          作者
  • @argument     参数
  • @class             类
  • @example       举例
  • @field              变量
  • @description   说明
  • @inner            私有
  • @private         内部
  • @version         版本
  • @return           返回值
  • @param           参数

    具体可以参考这个地址： http://code.google.com/p/jsdoc-toolkit/wiki/TagReference