Java--javadoc命令生成说明书

通过javadoc命令生成说明书
    * @author(提取作者内容)
    * @version(提取版本内容)
    * javadoc -d 指定的文件目录 -author -version ArrayTool.java
    * @param 参数名称//形式参数的变量名称
    * @return 函数运行完返回的数据

1、生成类并加入注释说明，如下

/**
这是一个数组工具类,里面封装了查找数组最大值,打印数组,数组反转的方法
@author zhangming
@version v1.0
*/
public class ArrayTool {
	//如果一个类中所有的方法都是静态的,需要再多做一步,私有构造方法,目的是不让其他类创建本类对象
	//直接用类名.调用即可
	/**
	私有构造方法
	*/
	private ArrayTool(){}

	//1,获取最大值

	/**
	这是获取数组中最大值的方法
	@param arr 接收一个int类型数组
	@return 返回数组中最大值
	*/
	public static int getMax(int[] arr) {
		int max = arr[0];						//记录第一个元素
		for (int i = 1;i < arr.length ;i++ ) {	//从第二个元素开始遍历
			if (max < arr[i]) {					//max与数组中其他的元素比较
				max = arr[i];					//记录住较大的
			}
		}

		return max;								//将最大值返回
	}
	//2,数组的遍历
	/**
	这是遍历数组的方法
	@param arr 接收一个int类型数组
	*/
	public static void print(int[] arr) {
		for (int i = 0;i < arr.length ;i++ ) {	//遍历数组
			System.out.print(arr[i] + " ");
		}
	}
	//3,数组的反转
	/**
	这是数组反转的方法
	@param arr 接收一个int类型数组
	*/
	public static void revArray(int[] arr) {
		for (int i = 0;i < arr.length / 2 ;i++ ) {	//循环次数是元素个数的一半
			/*
			arr[0]与arr[arr.length-1-0]	交换
			arr[1]与arr[arr.length-1-1]	交换
			arr[2]与arr[arr.length-1-2] 交换
			*/
			int temp = arr[i];
			arr[i] = arr[arr.length-1-i];
			arr[arr.length-1-i] = temp;
		}
	}
}

2、找到当前java文件所在的路径，按住Shift+右键选择在此处打开命令窗口，执行命令javadoc -d API指定的文件目录 -author -version ArrayTool.java，如下

 

因为Java文件在桌面，所以这时我们可以看到桌面上多了一个API文件，打开index.html进行访问，如图

 

3、调用当前工具类，新建一个类直接使用类名调用这个工具类

class Demo1_ArrayTool {
	public static void main(String[] args) {
		int[] arr = {33,11,22,66,55,44};
		/*ArrayTool at = new ArrayTool();
		int max = at.getMax(arr);				//��ȡ��ֵ
		System.out.println(max);
		
		System.out.println("---------------");
		at.print(arr);							//��ӡ
		System.out.println();
		System.out.println("---------------");
		System.out.println("��ת��:");
		at.revArray(arr);						//��ת
		at.print(arr);	*/

		ArrayTool.print(arr);
	}
}