Java之JavaDoc

我们知道在Java的注释中，一共有两种格式，第一种是行注释(line comment)，第二种是段注释(block comment)。

对于第二种注释，我们还可以进行细分：普通的段注释和文档型的段注释

普通的段注释:

/*
 * It is an ordinary block comment
 */

Javadoc段注释:

/**
 * It is a Javadoc block comment
 */

其区别在于注释的开头处，前者是 /* 开头，后者是 /**

后者的引用主要是为了生成开发文档(HTML格式)

比如我们看看高德地图API的开发文档：

下面我们来生成自己的API开发文档：

首先创建一个简单的Test类:

/*
 * Date: 2012-12-12
 */
package org.javadoc;

/**
 * This is a sample Class
 * 
 * @author tsw
 * @since 1.0
 * @version 1
 */
public class Test {

	/**
	 * <p>This is a sample variable</p>
	 * <b>It is used for counting</b>
	 */
	public int counter;
	
	/**
	 * <p>This is a sample method</p>
	 * 
	 * @param a left-operand
	 * @param b right-operand
	 * @return The sum of a & b
	 */
	public int calculate(int a, int b) {
		return a + b;
	}
}

接下来在命令行中敲入:

结果:

进入G:/mytest，查看生成的目录结构:

打开index.html:

如何在Eclipse集成开发环境中生成Javadoc:

点击项目右键->选择Export(输出)->Java->Javadoc

在弹出的对话框中，Javadoc Command 文件路径定位到jdk下的javadoc.exe,比如:C:\Program Files\Java\jdk1.7.0_07\bin\javadoc.exe

Destination选择生成文档的路径。