Java文档说明书的制作

最新推荐文章于 2019-11-27 08:58:30 发布

cangerwjd

最新推荐文章于 2019-11-27 08:58:30 发布

阅读量1k

点赞数

CC 4.0 BY-SA版权

文章标签： Java

本文链接：https://blog.youkuaiyun.com/cangerwjd/article/details/79915133

本文档介绍了如何创建一个针对数组操作的Java工具类ArrayTool，包括如何使用Javadoc生成文档注释，以及ArrayTool类中提供的遍历、求最大值和查找元素功能的方法详细说明。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

以数组为例，制作属于自己的文档说明书！

/**
* 针对数组操作的工具类
*     如何制作一个文档说明书
*             1)创建一个数组,静态初始化
*             2)创建一个工具类,ArrayTool,提供一些静态功能
*                     遍历,最值,查找
*             3)ArrayTool,每类,方法加上文档注释
*             4)打开dos控制台:
*                 找到当前路径:
*                         javadoc -d(目录名) -author -version ArrayTool.java
*
*/
public class ArrayDemo {
   public static void main(String[] args) {
       //创建一个数组,静态初始化
       int[] arr = {53,89,27,10,30} ;
       //遍历
       ArrayTool.printArray(arr);
       //求最大值
       int max = ArrayTool.getMax(arr) ;
       System.out.println("max:"+max);
       //查找
       int index = ArrayTool.getIdex(arr, 27) ;
       System.out.println("index:"+index);
   }
}

/**
* 这是针对数组操作的一个工具类,该工具类提供了一些数组的遍历,获取数组的最大值以及查找数组的元素的功能
* @author Administrator
* @version V1.0
* */
public class ArrayTool {

   /**
   * 这是一个私有的无参构造,目的是为了不让外界创建对象
   * */
   private ArrayTool() {

   }

   /**
   * 这是数组遍历的方法
   * @param arr 是一个int类型的数组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 需要在当前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 getIdex(int[] arr,int value) {
       int index = -1 ;
       for(int x = 0 ; x < arr.length ; x ++) {
           if(arr[x] == value) {
               return x ;
           }
       }
       return index ;
   }
}