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在文件夹中的目录