jsdoc 安装

windows 下步骤:

1。下载 jsdoc

2。下载安装 perl 环境,www.activeperl.com

3。安装一个非标准的 perl 模块,HTML::Template
这步很关键,搞了半天才装上

在命令行执行:C:\> ppm 会启动 perl package manager, 注意这时一定要是在线的,它启动时会去网站找所有的包,我开始就是没上网,怎么也找不到template包

在搜索栏中输入:HTML-Template

在列表中右键点击 HTML-Template,选 install,这时它只是选中状态,还要点 File -> Run Maked Actions

4。测试

命令行下进入jsdoc 的解压缩文件夹,执行:perl jsdoc.pl test.js

5。用法

jsdoc 标记:

@param

@argument

@return
指定返回值

@author

@see
创建一个html链接,指向指定类的描述

@version

@requires
创建一个html链接,指向这个类所需的指定类

@throws

@exception

{@link}
于@see 很相似,但它能嵌入在注释文本中

@fileoverview
如果在文件的第一个文档块中使用这个标记,则指定此文档块用来提供这个文件的概述

@class
提供类的信息,用在构造函数的文档中

@constructor

@type
指定返回类型

@extends

@private

@final

@ignore
irini   2007-05-07 09:59:33 评论:0   阅读:761   引用:0

发表评论>>

署名发表(评论可管理,不必输入下面的姓名)

姓名:

主题:

内容: 最少15个,最长1000个字符

验证码: (如不清楚,请刷新)

Copyright@2008 powered by YuLog