幫助文檔的生成

1.首先編寫一個方法類：

package 幫助文檔的製作;
/**
 * 
 * 
 * 這個是針對數組操作的一些工具類
 * @author 樑浩輝
 * @version v1.0
 */
public class ArrayUtil {
	
	private ArrayUtil() { };
	/**
	 * 遍歷一維數組的方法
	 * @param arr
	 */
	public static void show(int arr[]) {
		for(int i=0;i<arr.length;i++) {
			if(i==arr.length-1) {
				System.out.print(arr[i]);
			}else {
				System.out.print(arr[i]+",");
			}
		}
	}
	
/**
 * 
 * 這方法用於查找數組某個元素第一次出現的位置
 * @param a 你需要查找的第一次出現位置元素值
 * @param arr	你需要查找的數組
 */
	public static void FirstTime(int a,int arr[]) {
		for(int i=0;i<arr.length-1;i++) {
			if(arr[i]==a) {
				System.out.println("這個數第一次出現在"+(i+1)+"位上");
			}else if(i==arr.length-2&&arr[i]!=a) {
				System.out.println("沒有出現過這個數 ");
			}
		}
	}
	
	/**
	 * 
	 * 查找並返回最大值
	 * @param arr 需要查找的數組
	 * @return	返回最大值
	 */
	public static int  getMax(int arr[]) {
		int max=arr[0];
		for(int i=0;i<arr.length-1;i++) {
			if(max<arr[i]) {
				max=arr[i];
			}
		}
		return max;
	}
}

編寫文檔時要使用文檔註釋
格式：
/**
*
*
*
*/

author作者
version版本

2.創建doc文檔
（1）點擊project或者“項目”—>Generate Javadoc或者“生成javadoc”
（2）彈出以下窗口：

javadoc命令：配置javadoc程序–然後選擇要生成需要生成文檔的類–
點擊完成

3.查看文檔：
打開所保存的目錄

使用瀏覽器打開index.html即可進行文檔的查看。

效果如圖下：