Javascript文档利器: JsDoc Toolkit

Javascript文档利器: JsDoc Toolkit

 

随着Web2.0的风靡，Javascript已经成为一门被人们重新认识的编程语言，由于大量JS开源框架的出现，利用Javascript开发 的项目越来越多，越来越大。同时，也有越来越多Javascript开发问题暴露出来，如性能、网页加载速度等，其中，Javascript文档维护也成 为了开发者亟待解决的一个难题。

许多现代编程语言都有自己的集成化文档生成工具，像Java有JavaDoc ，.NET有NDoc ，PHP有PHPDoc ，这些自动化文档工具可以根据代码中的注释自动生成代码文档。

JsDoc Toolkit 就是这样一个自动化文档工具，它是发布在Google code 上的一个开源项目，和其他语言的文档工具一样，它可以自动从Javascript代码中提取注释生成格式化文档。

下载地址

http://code.google.com/p/jsdoc-toolkit/downloads/list

运行环境

JsDoc Toolkit是用Java开发的，运行时需要以下环境：

1. WindowXP
   java version "1.6.0_03"
   Java(TM) SE Runtime Environment (build 1.6.0_03-b05)
2. Mac OS X 10.5
   java version "1.5.0_19"
   Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_19-b02-304)

其它版本的Java可能导致JsDoc Toolkit运行失败。

用法

在运行之前，你需要把当前的工作目录切换到JsDoc Toolkit目录，并确保将java.exe所在目录添加到环境变量中。

 

详见: http://code.google.com/p/jsdoc-toolkit/w/list