java小例子：使用javadoc工具生成API文档

Javadoc命令可对源文件、包生成API文档，javadoc命令的基本用法如下：

javadoc  选项 Java源文件/包

javadoc的常用选项有一下几个：

-d<diretory>：该选项指定一个路径，用于将生成的API文档放到指定的目录下。

-windowtitle<text>：该选项指定一个字符串，用于设置API文档的浏览器窗口标题。

-doctitle<html-code>：该选项指定一个HTML格式的文本，用于指定概述页面的标题。

-header<html-code>：该选项制定一个HTML格式的文本，包含每个页面的页眉。

例如：

定义学生、教师、教室 3个类，分别编写文档注释：

package crazy.test.doctest.Student.java

package crazy.test.doctest;
/**
 * Description:
 * <br/>网站：<a href="http://www.csdn.net">CSDN社区</a>
 * <br/>Copyright (C), 2001-2012,bigboy
 * <br/>This program is protected by copyright laws.
 * <br/>Program Name: Class Student
 * <br/>Date:2013-3-14
 * @author bigboy
 * @version 1.0
 *
 */
public class Student {

	protected String Sname;
	protected String Sage;
	protected String Ssex;
	
	/**
	 * 
	 * @return 返回学生名字
	 * 
	 */
	public String getSname() {
		return Sname;
	}
	
	
	/**
	 * 
	 * @param sname 该参数指定学生的名字
	 */
	public void setSname(String sname) {
		Sname = sname;
	}
	
	
	
}

对crazy.test.doctest包下的java文件进行生成API文档，在命令窗口进入该包所在的路径下，执行如下命令：

运行后得到文档：