JSDoc 介绍使用规范JsDoc的使用介绍


Posted in Javascript onFebruary 12, 2011

JsDoc Toolkit不久前发布了2.3.2版本,主要还是对前版本的修复。
如果你需要使用Ant,JsDoc还有一个Ant插件:JsDoc Toolkit Ant Task
下载JsDoc Toolkit2.3.2:http://jsdoc-toolkit.googlecode.com/files/jsdoc_toolkit-2.3.2.zip
命令名描述
@param @argument 指定参数名和说明来描述一个函数参数

@returns 描述函数的返回值
@author 指示代码的作者
@deprecated 指示一个函数已经废弃,而且在将来的代码版本中将彻底删除。要避免使用这段代码
@see 创建一个HTML链接,指向指定类的描述
@version 指定发布版本
@requires 创建一个HTML链接,指向这个类所需的指定类
@throws @exception 描述函数可能抛出的异常的类型
{@link} 创建一个HTML链接,指向指定的类。这与@see很类似,但{@link}能嵌在注释文本中
@fileoverview 这是一个特殊的标记。如果在文件的第一个文档块中使用这个标记,则指定该文档块的余下部分将用来提供这个文件的概述
@class 提供类的有关信息,用在构造函数的文档中
@constructor 明确一个函数是某个类的构造函数
@type 指定函数的返回类型
@extends 指示一个类派生了另一个类。JSDoc通常自己就可以检测出这种信息,不过,在某些情况下则必须使用这个标记
@private 指示一个类或函数是私有的。私有类和函数不会出现在HTML文档中,除非运行JSDoc时提供了--private命令行选项
@final 指示一个值是常量值。要记住JavaScript无法真正保证一个值是常量
@ignore JSDoc忽略有这个标记的函数

JsDoc:是js文档生成工具,它从javascript程序源代码中抽取类、方法、成员等注释信息形成一个和源代码配套的API帮助文档。
Java开源项目http://www.jsdoctoolkit.org/,它是一个功能强大的javascript文档生成工具。
下面我们来结束一下如何使用。
我们通过下载工具类库。
这里我们使用的是jsdoc_toolkit-2.1.0.zip也是当前的最高版本。
我们将这个文件解压。可以看到里面README.txt文件。
这里有详细的使用说明。【好像介绍到这里就可以了。当然你也可以继续读下】
这里我们需要通过命令行进行创建javascript文档。
java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc test/*.js
当然如果感觉通过命令行的方式比较麻烦,我们可以自行创建一个.bat文件
将上面的内容复制到该文件中,执行即可。
下面我来简单解释一下这其中的参数
-a 表示全部的方法
-e 表示对应的文件的编码根式 这里对应的是GB18030 默认的是utf-8
-t 表示生产doc的文档样式模板
这里的test/*.js表示在test目录下的全部javascript文件
执行完毕后将文档结果默认输出到/out/jsdoc目录下。当然这个目录也是可以定义的
具体参数可以使用
java -jar jsrun.jar app/run.js --help
进行查看。
结果如下:

OPTIONS: 
-a or --allfunctions 
Include all functions, even undocumented ones. 
-c or --conf 
Load a configuration file. 
-d=<PATH> or --directory=<PATH> 
Output to this directory (defaults to "out"). 
-D="myVar:My value" or --define="myVar:My value" 
Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar. 
-e=<ENCODING> or --encoding=<ENCODING> 
Use this encoding to read and write files. 
-E="REGEX" or --exclude="REGEX" 
Multiple. Exclude files based on the supplied regex. 
-h or --help 
Show this message and exit. 
-n or --nocode 
Ignore all code, only document comments with @name tags. 
-o=<PATH> or --out=<PATH> 
Print log messages to a file (defaults to stdout). 
-p or --private 
Include symbols tagged as private, underscored and inner symbols. 
-q or --quiet 
Do not output any messages, not even warnings.

下面我们来创建test下的js文件
简单的方法标注
myjs.js
/** 
* @fileOverview 简单的方法标注示例 
* @author <a href="llying.javaeye.com">llying</a> 
* @version 0.1 
*/ /** 
* @description 加法运算 
* @param {Num} num1 加数 
* @param {Num} num2 被加数 
* @return {Num} result 结果 
*/ 
function add(num1,num2){ 
return num1 + num2; 
} 
/** 
* @description 减法运算 
* @param {Num} num1 减数 
* @param {Num} num2 被减数 
* @return {Num} result 结果 
*/ 
function minus(num1,num2){ 
return num1 - num2; 
}

类的方法标注
myjs2.js
/** 
* @fileOverview 简单的类对象标注示例 
* @author <a href="llying.javaeye.com">llying</a> 
* @version 0.1 
*/ 
/** 
* @author llying 
* @constructor Person 
* @description 一个Person类 
* @see The <a href="#">llying</a >. 
* @example new Parent(“张三”,15); 
* @since version 0.1 
* @param {String} username 姓名 
* @param {Num} age 年龄 
*/ 
function Person(username,age) 
{ 
/** 
* @description {Sting} 姓名 
* @field 
*/ 
this.username = username; 
/** 
* @description {Num} 年龄 
* @field 
*/ 
this.age = age 
/** 
* @description 弹出say内容 
* @param {String} content 内容 
*/ 
this.say = function(content) 
{ 
alert(this.username+" say :"+content); 
} 
/** 
* @description 返回json格式的对象 
* @return {String} json格式 
* @see Person#say 
*/ 
this.getJson = function(){ 
return "{name:"+this.username+",age"+this.age+"}"; 
} 
}

现在我们可以运行java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc test/*.js

至此我们的js文档生成完毕。我们也无需羡慕JavaDoc了。
JSDoc 介绍使用规范JsDoc的使用介绍
我们只是列出了常用的标签,至于更多的可以登陆到官方网站查看
http://code.google.com/p/jsdoc-toolkit/wiki/TagReference

Javascript 相关文章推荐
JavaScript中清空数组的三种方法分享
Apr 07 Javascript
用队列模拟jquery的动画算法实例
Jan 20 Javascript
jQuery+css3动画属性制作猎豹浏览器宽屏banner焦点图
Mar 16 Javascript
使用bootstrap实现多窗口和拖动效果
Sep 22 Javascript
详解React开发必不可少的eslint配置
Feb 05 Javascript
微信小程序中添加客服按钮contact-button功能
Apr 27 Javascript
使用svg实现动态时钟效果
Jul 17 Javascript
Vue中用props给data赋初始值遇到的问题解决
Nov 27 Javascript
JS异步执行结果获取的3种解决方式
Feb 19 Javascript
Vue.js组件通信之自定义事件详解
Oct 19 Javascript
vue2.x数组劫持原理的实现
Apr 19 Javascript
vue+elementUI实现简单日历功能
Sep 24 Javascript
编写可维护面向对象的JavaScript代码[翻译]
Feb 12 #Javascript
URL地址中的#符号使用说明
Feb 12 #Javascript
基于Jquery制作的幻灯片图集效果打包下载
Feb 12 #Javascript
基于jquery的jqDnR拖拽溢出的修改
Feb 12 #Javascript
jQuery1.4.2与老版本json格式兼容的解决方法
Feb 12 #Javascript
在vs2010中调试javascript代码方法
Feb 11 #Javascript
juqery 学习之六 CSS--css、位置、宽高
Feb 11 #Javascript
You might like
php 无限级分类学习参考之对ecshop无限级分类的解析 带详细注释
2010/03/23 PHP
PHP 中检查或过滤IP地址的实现代码
2011/11/27 PHP
Win下如何安装PHP的APC拓展
2013/08/07 PHP
PDO防注入原理分析以及使用PDO的注意事项总结
2014/10/23 PHP
PHP读取文件内容的五种方式
2015/12/28 PHP
修改Laravel5.3中的路由文件与路径
2016/08/10 PHP
PHP将数据导出Excel表中的实例(投机型)
2017/07/31 PHP
原生JS实现Ajax通过GET方式与PHP进行交互操作示例
2018/05/12 PHP
详解Webwork中Action 调用的方法
2016/02/02 Javascript
如何利用模板将HTML从JavaScript中抽离
2016/10/08 Javascript
bootstrap vue.js实现tab效果
2017/02/07 Javascript
jQuery选择器之子元素过滤选择器
2017/09/28 jQuery
使用webpack搭建react开发环境的方法
2018/05/15 Javascript
微信小程序云开发如何实现数据库自动备份实现
2019/08/16 Javascript
react实现同页面三级跳转路由布局
2019/09/26 Javascript
[09:37]2018DOTA2国际邀请赛寻真——不懈追梦的Team Serenity
2018/08/13 DOTA
简单学习Python time模块
2016/04/29 Python
解决Spyder中图片显示太小的问题
2018/04/27 Python
python实现机器人卡牌
2019/10/06 Python
python的faker库用法
2019/11/28 Python
Django实现从数据库中获取到的数据转换为dict
2020/03/27 Python
给ubuntu18安装python3.7的详细教程
2020/06/08 Python
如何利用pycharm进行代码更新比较
2020/11/04 Python
pycharm 实现调试窗口恢复
2021/02/05 Python
CHARLES & KEITH澳大利亚官网:新加坡时尚品牌
2019/01/22 全球购物
英国马匹装备和马术用品购物网站:Equine Superstore
2019/03/03 全球购物
美国折扣香水网站:The Perfume Spot
2020/12/12 全球购物
.NET面试题:什么是反射
2016/09/30 面试题
打造高效课堂实施方案
2014/03/22 职场文书
股权转让协议书范本
2014/04/12 职场文书
班级学雷锋活动总结
2014/06/26 职场文书
缓刑人员思想汇报500字
2014/09/12 职场文书
党的群众路线教育实践活动个人对照检查材料范文
2014/09/25 职场文书
浅谈Redis中的RDB快照
2021/06/29 Redis
zabbix自定义监控nginx状态实现过程
2021/11/01 Servers
聊聊Lombok中的@Builder注解使用教程
2021/11/17 Java/Android