怎么快速生成javascript 文档

JavaScript023

怎么快速生成javascript 文档,第1张

YUIDoc 是一个基于 Node.js 的应用程序。新建个文档写着javascript写入过程并保存操作如下:

(1)YUIDoc 是一个基于 Node.js 的应用程序,用来根据 JavaScript 的注释中生成 API 文档,类似 JavaDoc,这也是当前 YUI 用来生成文档的工具。生成的文档效果:

(2)如果操作系统是windows的用户,需要配置perl环境,推荐安装ActivePerl ,Linux/Unix用户则不用配置了。

(3)解压缩JsDoc,在命令提示窗口中进入JsDoc所在目录,使用如下命令即可生成Javascript代码的文档。

perl jsdoc.pl test.js

其中test.js是用于测试的js文件,如果成功则在该目录下生成js_docs_out目录,里面包含生成的文档。

(4)如果生成失败,产生如下错误信息:

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的官方网站。

总结:最终采用作用域的分析方式。即 函数调用 或 函数定义 被作为一个作用域。它们之前的 @class 将被理解为这个作用域内成员的父成员。

需要准备的材料分别有:电脑、html编辑器、浏览器。

1、首先,打开html编辑器,新建html文件,例如:index.html,填充问题基础代码。

2、在index.js中,实现func1和func2函数。

3、在index.html中,新增第3个button,并调用func3()方法,并在<script>标签中输入js代码:

function func3() {

$('body').append('use func3<br/>')

}

4、浏览器运行index.html页面,此时点击“函数3”按钮,能正常执行func3函数来输出内容。

建议楼主看下js基础

每一项都是js使用中的小技巧,基础但十分的实用!

1.document.write("")输出语句

2.JS中的注释为//

3.传统的HTML文档顺序是:

document->html->(head,body)

4.一个浏览器窗口中的DOM顺序是:

window->(navigator,screen,history,location,document)

5.得到表单中元素的名称和值:

document.getElementById("表单中元素的ID号").name(或value)

6.一个小写转大写的JS:

document.getElementById("output").value=document.getElementById("input").value.toUpperCase()

7.JS中的值类型:

String,Number,Boolean,Null,Object,Function

8.JS中的字符型转换成数值型:

parseInt(),parseFloat()

9.JS中的数字转换成字符型:

("" 变量)

10.JS中的取字符串长度是:

(length)

11.JS中的字符与字符相连接使用 号.

12.JS中的比较操作符有:

==等于,!=不等于,>,>=,<.<=

13.JS中声明变量使用:

var来进行声明

14.JS中的判断语句结构:

if(condition){}else{}

15.JS中的循环结构:

for([initial expression][condition][upadte expression]) {inside loop}

16.循环中止的命令是:

break

17.JS中的函数定义:

function functionName([parameter],...){statement[s]}

18.当文件中出现多个form表单时.可以用document.forms[0],document.forms[1]来代替.

19.窗口:

打开窗口window.open(), 关闭一个窗口:window.close(), 窗口本身:self

20.状态栏的设置:

window.status="字符"

21.弹出提示信息:

window.alert("字符")

22.弹出确认框:

window.confirm()

23.弹出输入提示框:

window.prompt()

24.指定当前显示链接的位置:

window.location.href="URL"

25.取出窗体中的所有表单的数量:

document.forms.length

26.关闭文档的输出流:

document.close()

27.字符串追加连接符: =

28.创建一个文档元素:

document.createElement(),document.createTextNode()

29.得到元素的方法:

document.getElementById()

30.设置表单中所有文本型的成员的值为空:

var form = window.document.forms[0]

for (var i = 0i<form.elements.lengthi ){

if (form.elements.type == "text"){

form.elements.value = ""

}

}