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文檔，在命令窗口進入該包所在的路徑下，執行如下命令：

運行後得到文檔：