目前AJAX正炒得火热,javaScript这个东西又有很多人重新重视起来,java有javaDoc这个工具生成文档,那么javaScript是否也有这样的工具呢?有,那就是JSDoc!
JSDoc是用Perl写的,所以要运行的话就需要Perl的运行环境,LInux和Unix默认都已经安装了perl,首先去http://jsdoc.sourceforge.net/下载一个新版的JSDoc,目前版本为1.9.9.2,下载后放到任意目录下解压即可,
例如/home/root下面,然后执行tar zxf JSDoc-1.9.9.2.gz 解压即可,进入解压后目录运行perl jsdoc.pl test.js
测试能否生成js doc文档,如果提示:Can't locate HTML/Template.pm in @INC ......这说明还需要安装HTML::Template Perl module,可以到http://www.cpan.org/上下载一个类似:HTML-Template-2.8.tar.gz之类的包,解压后进入目录运行以下命令:
perl Makefile.PLmake
make test
make install
ok!现在已一切经装好了,再进入JSDoc目录运行测试命令perl jsdoc.pl test.js,现在文档已经生成在js_docs_out目录下了,用浏览器打开index.html可以浏览了