帮助文档的制作javadoc

最近看java基础的视频，对制作java API有一点小心得，写出来大家共同交流学习。

要生成的java API文档：

/**
* 操作数组的工具类
* @author BOY
* @version V1.1
*/
public class ArrayTools {
/**
* 获取数组的最大值
* @param arr 传递一个整数类型数组的参数
* @return 返回整数类型数组的最大值
*/
public static int getMax(int[] arr){
int max = 0;
for(int i = 1 ; i < arr.length ; i++){
if(arr[i] > arr[max])
max = i;
}
return arr[max];
}
/**
* 获取数组的最小值
* @param arr 传递一个整数类型数组的参数
* @return 返回整数类型数组的最小值
*/
public static int getMin(int[] arr){
int min = 0;
for(int i = 0 ; i < arr.length ; i++){
if(arr[i] < arr[min])
min = i;
}
return arr[min];
}
/**
* 冒泡排序（从小到大排序）
* @param arr 传递一个参数为整数类型数组的参数
*/
public static void bubbleSort(int[] arr){
for(int x = 0 ; x < arr.length - 1 ; x++){
for(int y = 0 ; y < arr.length - 1 - x ; y++){
if(arr[y] > arr[y+1]){
swap(arr,y,y+1);
}
}
}
}
/**
* 选择排序（从大到小）
* @param arr 传递一个参数为整数类型数组的参数
*/
public static void selectSort(int[] arr){
for(int x = 0 ; x < arr.length - 1 ; x++){
for(int y = x + 1 ; y <  arr.length ; y++){
if(arr[x] < arr[y]){
swap(arr,x,y);
}
}
}
}
/**
* 交换数组中的两个元素位置
* @param arr 传递一个参数为整数类型数组的参数
* @param a  要传递的位置a
* @param b  要传递的位置b
*/
private static void swap(int[] arr,int a,int b){
arr[a] = arr[a] ^ arr[b];
arr[b] = arr[a] ^ arr[b];
arr[a] = arr[a] ^ arr[b];
}
/**
* 折半查找（数组按从小到大排序后）
* @param arr 传递一个参数为整数类型数组的参数
* @param key 要查找的目的数字key
* @param min 控制数组位置的左控制参数
* @param max 控制数组位置的右控制参数
*/
public static void halfFind(int[] arr,int key,int min,int max){
int mid = (max + min) / 2;
if(min > max){
System.out.print("There is no such number in the array!");
}
else if(arr[mid] == key)
System.out.println("Index = " + mid);
else if(arr[mid] > key){
max = mid - 1;
halfFind(arr,key,min,max);
}else if(arr[mid] < key){
min = mid + 1;
halfFind(arr,key,min,max);
}else
System.out.println("There is no such number in the array!");

}
/**
* 打印数组的结果
* @param arr 传递一个为整数类型的数组的参数
*/
public static void Print(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] + "]");
}
}
}

调用它的主类：

public class ArrayDemo {
public static void main(String[] args){
int[] arr = {18,8,39,2,10,4,3,9};
//显示数组
ArrayTools.Print(arr);

//获取最大值
System.out.println( "Max = " + ArrayTools.getMax(arr));

//获取最小值
System.out.println("Min = " + ArrayTools.getMin(arr));

//冒泡排序
ArrayTools.bubbleSort(arr);
ArrayTools.Print(arr);

//折半查找
int key = 18;
ArrayTools.halfFind(arr,key,0,arr.length-1);

//选择排序
System.out.print("Before:");
ArrayTools.Print(arr);
System.out.print("After:");
ArrayTools.selectSort(arr);
ArrayTools.Print(arr);

}

}

打开dos命令窗口：



（这里要设置classpath,不然ArrayDemo.java找不到ArrayTools.class，因为这里在当前目录，所以设置为.;即可）

把生成的帮助文档存储到myhelp文件夹中



最后打开index.html即可



另外还可以用Myecplise、ecplise等工具生成：

右键选择export，输入javadoc,然后按提示步骤选择要存储的目录即可。