Jsdoc
出自Developer Center
--iwind 2007年9月19日 (三) 11:03 (UTC)
目录 |
简介
JSDOC是使用PHP5书写的可以根据Javascript源代码注释生成文档的一组脚本，可以使用浏览器调用，也可以在命令行下运行.
它的样式和javadoc比较想象，含有包(package)、类(class)、对象(object)、属性（Property)、方法（Method）、构造器(Constructor)、函数(Function）等概念。一个例子是J-Framework的文档： http://develope.4kiki.net/framework/J/doc_0.4.1/
下载地址
使用例子
假设源代码目录是 D:\4kiki-svn\framework\jframework，生成文档目录是 D:\4kiki-svn\framework\jframework\docs\api ，文档标题是"J-Framework Document"， 则可以使用下面的命令(见下载包中的example.bat)：
@echo off cd parser php -f main.php -- -d=D:\4kiki-svn\framework\jframework\docs\api -s=D:\4kiki-svn\framework\jframework -t="J-Framework Document" pause
注释说明
- 使用/** 注释内容 **/ 的注释方法，而且在 **/之后必须有一个换行符
- 每一个元素必须包含它的父元素的名称，比如在类X中有一个方法setX()，那么在方法setX()的注释中就应该使用注释 @class X 来声明它所在的类
包(package)
格式：
/** * 包的说明 * * @package 包的名称 */
实例：
/** * 核心类 * * @package J.core */
类(class)
类注释中应该声明它所在的package
实例：
/** * JArray对象。<br/><br/><b>注意本对象中各种排序方法应该只应用于同种类型数据的集合，否则可能会产生预料不到的结果。</b> * * @class JArray * @package J.core */
对象(object)
对象注释中应该声明它所在的package
实例：
/**
* J-Framework的配置选项
*
* @object JConfig
* @package J.util
*/
var JConfig = JObject.inherited({});
属性（Property)
属性注释中应该声明它所在的class或者object
实例：
var JConfig = JObject.inherited({
/**
* J-Framework的版本号
* @var String version
* @since 0.0.3
* @object JConfig
*/
"version" : "J-Framework v0.4.1"
});
方法（Method）
方法注释中应该声明它所在的class或者object
实例：
/**
* 设置当前选项的内容
*
* @method setItem
* @param String value 值
* @param String text 文本
* @class JOption
*/
this.setItem = function (value, text) {
this.setValue(value);
this.setText(text);
};
构造器(Constructor)
构造器注释中应该声明它所在的class
实例：
/**
* 构造器
*
* @constructor JOption
* @param Object object option原始对象
* @since 0.3.0
* @class JOption
*/
function JOption(object) {
JClass.extend(this, JComponent);
}
函数(Function）
实例：
/**
* 取得单个id对应的对象
*
* @function $
* @param String id 对象的ID
* @return mixed Object或者JArray
* @since 0.4.1
*/
function $(id) {
return JElement.get(id);
}
