简介

  • 一款优秀的开源javascript文档工具,能通过一定格式的代码注释,自动生成代码文档。

安装配置

  • 如果机器上还没有安装java runtime environment,装一下吧
  • 下载程序到本地——下载地址
  • 当然如果你安装了svn,直接checkout更方便一点儿

Run

  • 新建一个test.js的文件,然后写上两句注释,要是用了中文用utf-8格式吧
    /**
    * @fileoverview 试试能不能用中文
    * @author 哥
    * @version my first js doc
    */
  • 运行cmd,进入命令行,进入到下载的文件夹的根目录
  • 运行java -jar jsrun.jar app\run.js -a -t=templates\jsdoc test.js.
  • 回下载目录看看去,是不是发现多了一个out文件夹,就这么简单,文档出来了。
  • 如果看不懂上面的命令行,运行java -jar jsrun.jar app\run.js -h 看看help文档吧,功能多多,要是喜欢个性化自己的文档格式,自己弄一套吧,我这里就只介绍一下官方发布的默认的格式。

注释格式

  • 注释以/**开头,以*/结束
  • 关键字以@开头

标签

  • 标签官方的文档写的很清楚了,而且有例子讲的很清楚,我这里就不多忽悠了。
  • 最后介绍一下我的心得:对于js原生的写法这个工具能够自动识别,但是要是用了框架或者封装过那就为必认识了,由于我经验也不丰富,不是很清楚什么不能识别,直接需要注释的全部强制指定算了。

小例子

/**
* @fileOverview an small example
* @author yanh
* @version 2010
*/

/** 原型继承函数
* @param {object} subClass
* @param {object}  supClass
*/
function __extend(b, p){
    var F = function(){};
    F.prototype = p.prototype;
    b.prototype = new F();
    b.prototype.constructor = b;
}
/**
* @class A类
* @param {string} name
* @constructor
* @returns {object} A实例对象
*/
var A = function(name){
	this.name = name;
};
A.prototype.setName = function(name){
	this.name = name;
};
/**
* @class B类
* @param {string} name
* @constructor
* @extends A
* @returns {object} B实例对象
*/
var B = function(name){
	A.call(this,name);
};
/** @lends B.prototype*/
__extend(B, A);
/**
 * get name
 * @returns {string}
 */
B.prototype.getName = function(){
	return this.name;
};

生成结果

本文作者:admin 转载请注明来自:携程设计委员会