帮助文档的生成

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即可进行文档的查看。

效果如图下：