1. 程式人生 > >Java--javadoc命令生成說明書

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);
	}
}