Dreamweaver教程 FrontPage教程 Flash教程 CSS教程
  • javascript教程
  • 当前位置:教程 > 网页制作 > javascript教程 > 正文

    Javascript文档生成

    编辑:教程网 来源:网络 时间:2011年11月06日 16:46

    Javascript文档生成是比较头疼的问题,不过现在已经有开源的工具可以使用——JsDoc。
    其官方站点地址:http://jsdoc.sourceforge.net/
    Release版的下载地址是:http://sourceforge.net/projects/jsdoc
    JsDoc是根据Javascript代码中的注释生成相应的帮助文档,它定义了一套注释标签规范。因此在编写Javascript代码时,要根据它能识别的注释标签进行注释。
    具体使用方法如下:
    1、如果操作系统是windows的用户,需要配置perl环境,推荐安装ActivePerl ,Linux/Unix用户则不用配置了。
    2、解压缩JsDoc,在命令提示窗口中进入JsDoc所在目录,使用如下命令即可生成Javascript代码的文档。
    perl jsdoc.pl test.js
    其中test.js是用于测试的js文件,如果成功则在该目录下生成js_docs_out目录,里面包含生成的文档。
    3、如果生成失败,产生如下错误信息:
    Can't locate HTML/Template.pm in @INC ......
    需要配置HTML::Template模块,配置方法为:
    进入perl的Package Manager,可以使用命令ppm,也可以点击开始菜单——ActivePerl 5.8.8 Build 817——Perl Package Manager。然后使用install命令安装HTML::Template模块,代码如下:
    C:> ppm
    PPM> install HTML-Template
    PPM> quit

    具体的参数及用法可以查看JsDoc的官方网站。


  • 原文来自 教程网 转载请注明:http://www.websmill.com/wangye/javascript/31725.html

  • 上一篇:关于搜索引擎页面分析中的 javascript 处理的2个思路
  • 下一篇:JS时钟