文档制作实例

---------------------- android培训、 java培训、期待与您交流！ ----------------------

面向对象文档制作实例

/**
 * 这是一个可以对数组进行操作的工具类，该类中提供了，获取最值，排序等功能。
 * @author 张三
 * @version V1.1
 * */
public class MianXiangDiuXiang_SixDay {
	private MianXiangDiuXiang_SixDay() {
	}
	/* 返回最大值，此方法为遍历判断脚标值、得出脚标 */
	/**
	 * 获取一个整形数组中的最大值
	 * @param arr 接收一个int类形的数组
	 * @return 会返回一个数组中的最大值
	 * */
	public static int getMax(int[] arr) {
		int max = 0;
		for (int i = 1; i < arr.length; i++) {
			if (arr[max] < arr[i]) {
				max = i;
			}
		}
		return arr[max];
	}

	/* 返回最小值，此方法为遍历判断脚标的值、得出数值 */
	/**
	 * 获取一个整形数组中的最小值
	 * @param arr 接收一个int类形的数组
	 * @return 会返回一个数组中的最小值
	 * */
	public static int getMin(int[] arr) {
		int min = arr[0];
		for (int i = 1; i < arr.length; i++) {
			if (min > arr[i]) {
				min = arr[i];
			}
		}
		return min;
	}

	/* 选择排序，把最小的值放到前面 */
	/**
	 * 用于给数组进行选择排序
	 * @param arr 接收一个int类形的数组
	 * */
	public static void selectSort(int[] arr) {
		for (int i = 0; i < arr.length - 1; i++) {
			for (int j = i + 1; j < arr.length; j++) {
				if (arr[i] > arr[j]) {
					swap(arr, i, j);
				}
			}
		}
	}

	/* 冒泡排序，把最大的值放到后面 */
	/**
	 * 用于给数组进行冒泡排序
	 * @param arr 接收一个int类形的数组
	 * */
	public static void bubbleSort(int[] arr) {
		for (int i = 0; i < arr.length - 1; i++) {
			for (int j = 0; j < arr.length - i - 1; j++) {
				if (arr[j] > arr[j + 1]) {
					swap(arr, j, j + 1);
				}
			}
		}
	}
	
	/* 将两个值交换 */
	/**
	 * 用于给数组中的两个值进行交换
	 * @param arr 接收一个int类形的数组，和两个int类型的整数
	 * */
	private static void swap(int[] arr,int i, int j) {
		int temp = arr[i];
		arr[i] = arr[j];
		arr[j] = temp;
		
	}
	
	/* 把数组打印在控制台上 */
	/**
	 * 用于给数组进行打印,打印形式：[elemet1,elemet2,elemet3......]
	 * @param arr 接收一个int类形的数组
	 * */
	public static void printArray(int[] arr) {
		System.out.print("[");
		for (int i = 0; i < arr.length; i++) {
			if (i < arr.length - 1) {
				System.out.print(arr[i]+"..");
			}else {
				System.out.println(arr[i] + "]");
			}
		}
	}
}

eclipse 制作API文档

1.选择工程，在菜单Project->Genarate Javadoc 
2.选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc ，点”next” 按钮 
3.选择工程，在菜单File->Export ，选择Java 下面的Javadoc ，点”next” 按钮 
然后，可以选择生成到Javadoc 文档中的内容( 一般选public 或protected) ，选存放目录( 默认即可) ，next下一步 ,此页全默认即可，再next 下一步 。 

---------------------- android培训、 java培训、期待与您交流！ ----------------------

详细请查看：http://edu.csdn.net/heima