JS技术

Javascript文档生成

字号+ 作者: 来源:    2014-11-17 20:00 我要评论( )

Javascript文档生成,阅读Javascript文档生成,Javascript文档生成是比较头疼的问题,不过现在已经有开源的工具可以使用——JsDoc。其官方站点地址:http://jsdoc.sourceforge.net/Release版的下载地址是:http://sourceforge.net/projects/jsdocJsDoc是根据Jav

Javascript文档生成是比较头疼的问题,不过现在已经有开源的工具可以使用——JsDoc。
其官方站点地址:
Release版的下载地址是:
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的官方网站。

 

1.本站遵循行业规范,任何转载的稿件都会明确标注作者和来源;2.本站的原创文章,请转载时务必注明文章作者和来源,不尊重原创的行为我们将追究责任;3.作者投稿可能会经我们编辑修改或补充。

相关文章
  • 学习JavaScript之this,call,apply

    学习JavaScript之this,call,apply

    2016-01-28 20:45

  • 轻松学习JavaScript十五:JavaScript之BOM简介 - 连宏伟 - 博客频道 - CSDN.NET 连宏

    轻松学习JavaScript十五:JavaScript之BOM简介 - 连宏伟 - 博客频道

    2015-12-13 11:34

  • Javascript文档生成_javascript教程教程

    Javascript文档生成_javascript教程教程

    2015-10-03 11:10

  • 学习Javascript数组_Javascript教程

    学习Javascript数组_Javascript教程

    2015-10-02 09:18

网友点评