overview.js

JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的

/**
 * @overview This "library" contains a 
 *               lot of classes and functions.
 * @example
 <pre>
	var x (x < 1);
	alert("This 'is' \"code\"");
 </pre>
 * @name My Cool Library
 * @author 	Joe Smith [e-mail]
 * @version 	0.1 
 */
 
/** 
 * Gets the current foo 
 * @param {String} fooId	The unique identifier for the foo.
 * @return {Object}	Returns the current foo.
 */
function getFoo(fooID){
}