JDK API文档的使用

/*JDK API文档：把部分文档暴露出来，把文件夹myhelp和ArrayTool.class复制给别人，别人就可以用运行这个工具类了。JDK API 1.6.0中文版*///3、工具类。/*将方法都静态后可以方便于使用，但是该类还是可以被其他程序建立对象的。为了更严谨，强制让该类不能建立对象。可以通过将构造函数私有化完成。接下来，将ArrayTool.class文件发送给其他人，其他人只要将该文件设置到classpath路径下，就可以使用该工具类。但是，该类中到底定义了多少方法，对方不清楚，因为该类并没有使用说明书。开始制作程序的说明书。java说明书通过文档注释来完成。*//**类的描述信息。这是一个可以对数组进行操作的工具类，该类中提供了，获取最大值、最小值、选择排序、冒泡排序、交换数据、打印数组功能。@author YSL@version v1.7*///class ArrayTool //必须public修饰才可以生成帮助文档，使用javadoc,否则在cmd中:E:\aday\day06>javadoc -d myhelp -author -version ArrayTool.java(在当前目录下新建一个myhelp的文件夹，或-dc:\myhelp在c盘新建一个myhelp文件夹，)public class ArrayTool {/**空参数构造函数*///将构造函数私有化，外界只能通过调用函数，防止建立对象。private ArrayTool(){}/**获取一个整型数组中的最大值@param arr 接收一个int类型的数组@return 返回一个该数组中的最大值*/public static   int getMax(int[] arr)//static：主要为了调用方便，因为main函数是static的。{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)//static：主要为了调用方便，因为main函数是static的。{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 selectSort(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);}}}}/**给int数组中两个元素进行位置的置换@param arr 接收一个int类型的数组@param a 要置换的位置@param b 要置换的位置*///public static void swap(int[] arr,int a,int b)//只提供给本类，不需要提交给外界，所以私有化private static void swap(int[] arr,int a,int b){int temp=arr[a];arr[a]=arr[b];arr[b]=temp;}/**打印数组中的元素，打印形式：[elemet1,elemet2,...]@param arr 接收一个int类型的数组*/public static void printArray(int[] arr){System.out.print("[");for (int x=0;x<arr.length;x++ ){if (x!=arr.length-1){System.out.print(arr[x]+",");}elseSystem.out.println(arr[x]+"]");}}}/*一个类中默认会有一个空参数的构造函数。这个默认的构造函数的权限和所属类一致。如果类被public修饰，那么默认的构造函数也带public修饰符，如果类没被public修饰，那么默认的构造函数，也没有public修饰。默认构造函数的权限是随着类的变化而变化的。*/