Javascript文档生成

819228729

819228729

2016-02-19 21:24

下面图老师小编要向大家介绍下Javascript文档生成,看起来复杂实则是简单的,掌握好技巧就OK,喜欢就赶紧收藏起来吧!

  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模块,代码如下:

(本文来源于图老师网站,更多请访问http://m.tulaoshi.com/webkaifa/)

                                 C: ppm
                                 PPM install HTML-Template
                                 PPM quit

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

(本文来源于图老师网站,更多请访问http://m.tulaoshi.com/webkaifa/)
展开更多 50%)
分享

猜你喜欢

Javascript文档生成

Web开发
Javascript文档生成

利用ASP生成EXECL文档

ASP
利用ASP生成EXECL文档

s8lol主宰符文怎么配

英雄联盟 网络游戏
s8lol主宰符文怎么配

根据xsd生成xml文档

Web开发
根据xsd生成xml文档

用FoxPro生成HTML文档

Web开发
用FoxPro生成HTML文档

lol偷钱流符文搭配推荐

英雄联盟 网络游戏
lol偷钱流符文搭配推荐

Javascript文档及其关联对象

Web开发
Javascript文档及其关联对象

ASP动态生成的javascript表单验证代码

Web开发
ASP动态生成的javascript表单验证代码

lolAD刺客新符文搭配推荐

英雄联盟
lolAD刺客新符文搭配推荐

如何确定有多少人登陆Access数据库?

如何确定有多少人登陆Access数据库?

在ACCESS中LIKE的用法

在ACCESS中LIKE的用法
下拉加载更多内容 ↓