API文檔-製作javadoc

要點：

對class文件寫上工具書

---

代碼展示區：

package com.java.JinTai;
/**
 * 針對數組進行操作的工具類
 * @author 方楊
 * @version V.10
 */

public class ArrayTool{

    /**
     * 這是私有構造
     */
    private ArrayTool(){}
    /**
     * 這是遍歷數組的方法，便利後的格式是：[元素1,元素2,元素3,......]
     * @param int[] 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]+",");
            }
        }
    }

    /**
     * 這是獲取數組中最大值的方法
     * @param int[] arr 這是要獲取最大值的數組
     * @return int 返回數組中的最大值
     */
    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 int[] arr被查找的數組
     * @param int value 要查找的元素
     * @return int 返回元素在數組中的索引，如果不存在，返回-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;
    }
}

文檔製作結果：

• 生成doc在文件夾中的目錄