javadoc简易数组工具类文档(API)

Posted 2020-09-28

制作简易数组工具类文档(API)
 如何创建文档
 以数组工具类（Array）为例
一丶创建一个数组工具类
  要求实现(1)遍历数组（2）求数组中的最大值（3）查询数组中的元素在数组中第一次出现的索引（4）将数组元素翻转并遍历
 /**
 * 这是数组的一个工具类
 * @author Apple
 * @version V1.0
 * */
 public class Array{
  private Array(){ //将无参构造私有化，无法实例化
  }
  
  /**遍历数组
  * @param arr :需要被遍历的数组
  */
  public static void blArray(int[] arr){ //使用static修饰，随着类的加载而加载，使其可以直接用类名调用；
   for(int i = 0;i < arr.length;i++){
    System.out.print(arr[i] + "\t");
   }
  }
  
  /**
  * 求数组中最大值
  * @param arr:需要被查询的数组
  * @return 返回的就是我们要查找的最大值
  * */
  public static int maxArray(int[] arr){
   int max = arr[0];
   for(int i = 0;i < arr.length;i++){
    if(max < arr[i]){
     max = arr[i];
    }
   }
   return max;
  }
  
  /**
  * 查询数组中的元素在数组中第一次出现的索引,如果查不到,返回-1
  * @param arr :需要查询单数组
  * @param value :需要查询单 元素
  * @return :返回的该元素在数组中第一次出现的索引的值
  * */
  public static int syArray(int[] arr,int value){
   int wz = -1;
   for(int i = 0;i < arr.length;i++){
    if(value == arr[i]){
     wz = i;
     break;
    }
   }
   return wz;
  }
  
  /**翻转并遍历数组
  * @param arr :需要被翻转遍历的数组
  */
  public static void fzArray(int[] arr){
   int[] arr1 = new int[arr.length];
   for(int i = 0;i < arr.length;i++){
    arr1[arr.length - 1 - i] = arr[i]；
   }
   for(int x = 0;x < arr1.length;x++){
    System.out.print(arr1[x] + "\t")；
   }
  }
 }
二丶测试
  测试数组工具类功能是否可用
 public class ArrayTest{
  public static void main(String[]ages){
   int[] arr = {212,34,45,2,6,24,2,73,24};
   //数组遍历
   Array.blArray(arr);
   //求数组中的最大值
   int i = Array.maxArray(arr);
   System.out.println("最大值为：" + i);
   //求24元素在数组中第一次在出现的索引
   int j = Array.syArray(arr,24);
   System.out.println("24第一次出现在" + j + "位置");
   //遍历翻转数组
   Array.fzArray(arr);
  }
 }
三丶文档（API）生成
  启动cmd
  javadoc -d 目录(Array.java文件所在的目录) -author -version Array.java

效果图