1:如何製作幫助文件(瞭解)

(1)寫一個類

(2)加入文件註釋

(3)通過javadoc工具生成即可

javadoc -d 目錄 -author -version ArrayTool.java

/*
 我想要對陣列進行操作
 在同一個資料夾下，類定義在兩個檔案中和定義在一個檔案中其實一樣的。
*/
class ArrayDemo {
 public static void main(String[] args) {
 //定義陣列
 int[] arr = {28,55,37,46,19};
 //需求：遍歷陣列
 /*
 for(int x=0; x<arr.length; x++) {
 if(x == arr.length-1) {
 System.out.println(arr[x]);
 }else {
 System.out.print(arr[x]+", ");
 }
 }
 */
 //如果我有多個數組都要進行遍歷，那麼，程式碼的重複度就很高
 //如何改進呢?用方法改進
 //呼叫
 //靜態方法
 //printArray(arr);
 //非靜態方法
 //ArrayDemo ad = new ArrayDemo();
 //ad.printArray(arr);
 //測試類的作用：建立其他類的物件，呼叫其他類的功能。
 //而我們現在的操作是跟陣列相關的，所以，你應該把這些操作定義到陣列操作類中
 //定義一個數組的操作類
 //有了陣列操作類之後的呼叫
 //ArrayTool at = new ArrayTool();
 //at.printArray(arr);
 //方法改進為靜態後，就可以直接通過類名呼叫
 ArrayTool.printArray(arr);
 }
 /*
 public static void printArray(int[] arr) {
 for(int x=0; x<arr.length; x++) {
 if(x == arr.length-1) {
 System.out.println(arr[x]);
 }else {
 System.out.print(arr[x]+", ");
 }
 }
 }
 */
 //假設該方法不是靜態的
 /*
 public void printArray(int[] arr) {
 for(int x=0; x<arr.length; x++) {
 if(x == arr.length-1) {
 System.out.println(arr[x]);
 }else {
 System.out.print(arr[x]+", ");
 }
 }
 }
 */
}
lass ArrayTool {
 //把構造方法私有，外界就不能在建立物件了
 private ArrayTool(){}
 public static void printArray(int[] arr) {
 for(int x=0; x<arr.length; x++) {
 if(x == arr.length-1) {
 System.out.println(arr[x]);
 }else {
 System.out.print(arr[x]+", ");
 }
 }
 }
}
/*
 我想要對陣列進行操作
 如何製作一個說明書呢?
 A:寫一個工具類
 B:對這個類加入文件註釋
 怎麼加呢?
 加些什麼東西呢?
 C:用工具解析文件註釋
 javadoc工具
 D:格式
 javadoc -d 目錄 -author -version ArrayTool.java
 目錄：就可以寫一個資料夾的路徑
 製作幫助文件出錯：
 找不到可以文件化的公共或受保護的類：告訴我們類的許可權不夠
*/
class ArrayDemo {
 public static void main(String[] args) {
 //定義陣列
 int[] arr = {28,55,37,46,19};
 //遍歷
 ArrayTool.printArray(arr);
 //獲取最值
 int max = ArrayTool.getMax(arr);
 System.out.println("max:"+max);
 //獲取55的索引值
 int index = ArrayTool.getIndex(arr,55);
 System.out.println("index:"+index);
 }
}
/**
* 這是針對陣列進行操作的工具類
* @author 劉意
* @version V.10
*/
public class ArrayTool {
 //把構造方法私有，外界就不能在建立物件了
 /**
 * 這是私有構造
 */
 private ArrayTool(){}
 /**
 * 這是遍歷陣列的方法，遍歷後的格式是：[元素1, 元素2, 元素3, ...]
 * @param arr 這是要被遍歷的陣列
 */
 public static void printArray(int[] arr) {
 System.out.print("[");
 for(int x=0; x<arr.length; x++) {
 if(x == arr.length-1) {
 System.out.println(arr[x]+"]");
 }else {
 System.out.print(arr[x]+", ");
 }
 }
 }
 /**
 * 這是獲取陣列中最大值的方法
 * @param  arr 這是要獲取最大值的陣列
 * @return 返回陣列中的最大值
 */
 public static int getMax(int[] arr) {
 int max = arr[0];
 for(int x=1; x<arr.length; x++) {
 if(arr[x] > max) {
 max = arr[x];
 }
 }
 return max;
 }
 /**
 * 獲取指定元素在陣列中第一次出現的索引，如果元素不存在，就返回-1
 * @param arr 被查詢的陣列 
 * @param value 要查詢的元素
 * @return 返回元素在陣列中的索引，如果不存在，返回-1
 */
 public static int getIndex(int[] arr,int value) {
 int index = -1;
 for(int x=0; x<arr.length; x++) {
 if(arr[x] == value) {
 index = x;
 break;
 }
 }
 return index;
 }
}
 

2:通過JDK提供的API學習了Math類(掌握)

(1)API(Application Programming Interface)

應用程式程式設計介面(幫助文件)

(2)如何使用呢?

請參照

day08code