Javascript文档生成

2016-02-19 21:24 7 1 收藏

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

【 tulaoshi.com - Web开发 】

  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、如果生成失败,产生如下错误信息:

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

                                 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

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

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

来源:http://www.tulaoshi.com/n/20160219/1626090.html

延伸阅读
标签: 电脑入门
在平时使用Word时,经常会遇到将一个Word文档的内容制作成为一个PowerPoint文档的工作。通常是利用复制+粘贴的方法来完成,这样做要进行多次的窗口切换和复制、粘贴,是比较繁琐的操作。而Word与PowerPoint同是Microsoft Office家族中的两个软件,它们之间应该可以实现数据共享,应该有更好的办法。方法如下: 利用Word文档中的发送命令:在W...
标签: PHP
  摘要 本论文简要介绍了PHP、XML、PDF等技术的原理以及它们的应用情况。力图运用PHP面向对象的特性,构建出一套基于PHP和XML的在线PDF文档生成系统。文中详细探讨了整个系统的组成部分以及各自的实现过程。并在最后给出一个运用这套系统实现的动态创建报表的实例。 Abstract This article introduced the fundamentls of PHP...
标签: word
Word 2007:长文档目录自动生成的妙招   目录,就是一本书或者是一篇长文档,第一页就能看到的文章编排次序,方便阅读者查阅,检索。而在我们平时在编辑常文档也可以插入目录。但是图老师小编发现大家都是手动制作目录,OUT啦,Word 2007中又自动创建目录的。 1、[开始]--[样式] 样式 2、在[样式]中,主要就是用到...
标签: Web开发
一、必须弄清楚最终需要的是什么 我们通过asp或其他动态编程语言,最终需要的是XML格式的数据,这点和XML数据所在的文件载体无关,它可以是实实在在的XML文件,比如:http://blog.cnd8.com/rss_1.xml 。也可以为asp文档,比如:http://school.cnd8.com/rss.asp?id=42 他们都是XML数据的体现,为了实现XML数据的动态,所以需要使...
标签: 电脑入门
在Word文档中,若要在标题的前面自动生成章节号,比如第X章,1.1等,需要对标题进行大纲等级设置,具体的设置请参见样式的设置。在标题设置好后依次点击菜单栏的格式-项目符号和编号打开项目符号和编号对话框,再选择多级符号选项卡。 可以任选一个多级符号样式进行进一步的设置,在本文中我选择第二个样式进行进一步的设置。点击多级符号...

经验教程

528

收藏

92
微博分享 QQ分享 QQ空间 手机页面 收藏网站 回到头部