面向对象—05—制作帮助文档

最新推荐文章于 2025-02-18 09:48:02 发布

原创最新推荐文章于 2025-02-18 09:48:02 发布 · 408 阅读

CC 4.0 BY-SA版权

本文详细介绍了如何为Java工具类编写帮助文档，包括类的声明、构造函数、方法注释以及实例说明，旨在使使用者能够更好地理解并利用类的功能。

帮助文档的制作
将ArrayTool.class文件发送给其他人，
其他人只要将该文件设置到classpath路径下，就
可以使用该工具类
但是，该类中到底定义了多少个方法，对方不清楚
因为该类并没有使用说明书。
开始制作程序的说明书，java的说明书通过文档
注释来完成。

/**
这是一个可以对数组进行操作的工具类，该类中提供
了获取最值，排序等功能
@author 张三
@version V1.1
*/
public class ArrayTool //建立说明文档，类必须是public修饰
{
/**
空参数构造函数
*/
private ArrayTool(){}//私有化构造函数，不能建立对象
/**
获取一个整形数组中的最大值
@param arr 接收一个int类型的数组
@return 会返回一个该数组中最大值
*/
public static int getMax(int[] arr) //取最大值
{
  int max = 0;
  for(int x=1; x<arr.length; x++)
  {
   if(arr[x]>arr[max])
    max = x;
  }
  return arr[max];
}

/**
获取一个整形数组中的最小值
@param arr 接收一个int类型的数组
@return 会返回一个该数组中最小值
*/
public static int getMin(int[] arr)//取最小值
{
  int min = 0;
  for(int x=1; x<arr.length; x++)
  {
   if(arr[x]<arr[min])
    min = x;
  }
  return arr[min];
}
/**
给int类型数组进行排序
@param arr 接收一个int类型的数组，使用选择排序
*/
public static void selcetSort(int[] arr)//选择排序
{
  for(int x=0; x<arr.length-1; x++)
  {
   for(int y=x+1; y<arr.length; y++)
   {
    if(arr[x]>arr[y])
    {
     swap(arr,x,y);
    }
   }
  }
}
/**
给int类型数组进行排序
@param arr 接收一个int类型的数组，使用冒泡排序
*/
public static void bubbleSort(int[] arr)//冒泡排序
{
  for(int x=0; x<arr.length-1; x++)
  {
   for(int y=0; y<arr.length-x-1; y++)
   {
    if(arr[y]>arr[y+1])
    {
     swap(arr,y,y+1);
    }
   }
  }
}
/**
给数组中的元素进行位置的置换
@param arr 接收一个int类型的数组
@param a 要置换的位置
@param b 要置换的位置
*/
private static void swap(int[] arr,int a,int b)//交换元素
{
  int temp = arr[a];
  arr[a] = arr[b];
  arr[b] = temp;
}
/**
用于打印数组中元素，打印形式是：[element,element2,...]
*/
public static void printArray(int[] arr)//输出函数
{
  System.out.print("[");
  for(int i=0; i<arr.length; i++)
  {
   if(i != arr.length-1)
    System.out.print(arr[i]+",");
   else
    System.out.println(arr[i]+"]");
  }
}
}