Javascript文档生成

2016-02-19 21:24 4 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、如果生成失败,产生如下错误信息:

(本文来源于图老师网站,更多请访问https://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

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

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

来源:https://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...
标签: Web开发
Document文档对象是JavaScript中window和frames对象的一个属性,是显示于窗口或框架内的一个文档。描述当前窗口或指定窗口对象的文档。它包含了文档从head到/body的内容。 用法:document (当前窗口) 或 窗口对象.document (指定窗口) 属性: document.title //设置文档标题等价于HTML的title标签 document.bgColor //设置页面背景色 ...
标签: Web开发
使用浏览器的内部对象系统, 可实现与HTML文档进行交互。它的作用是将相关元素组织包装起来,提供给程序设计人员使用,从而减轻编程人的劳动,提高设计Web页面的能力。 二、文档对象功能及其作用 在Navigator浏览器中,document文档对象是核心是,同时也是最重要的。见表6-1所示。 Links Anchor Form Method Prop 链接对象 ...
标签: Web开发
一个项目需要显示QQ在线状态,就按照需要简单写了一小段代码,放上来共享一下,没写成函数有需要的朋友自行修改下应该很简单,另外这个状态显示未加任何限制,或许会碰到所谓的骚扰,腾讯官方的状态代码已经加上会话权限设置了,我这个图省事未加会话权限设置。可以保存到独立js文件中调用,还算比较简单方便:) 程序代码 script type="text/...

经验教程

838

收藏

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