JSDOC学习记录

作用

     为js文件生成文档的一个自动化工具，类似于java-doc功能。通过读取javascript中一定格式的注释内容生成对应的文     档。

 

如何使用jsdoc

      将jsdoc下载之后，在对应的目录下运行命令：

       java -jar jsrun.jar app/run.js -a -t=templates/jsdoc app/test.js 就可以了。

       

         参数说明：

               -a   全部生成文档包括没有注释的方法。

               -t    使用模板的地址

               -d    生成文档的输出目录

 

        具体的标签参考http://code.google.com/p/jsdoc-toolkit/。

 

工作原理

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

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

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

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

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

 

   工作模式  :   就是通过一段java代码调用rhino框架提供了一个运行javascript的环境，然后再运行javascript读取生成文档的javascript文件和模板文件生成文档。