引自:http://blog.csdn.net/kangmiao89757/article/details/10656473
静态的应用——文档说明书。
每一个应用程序中都有共性的功能,可以将这些功能进行抽取,独立封装。以便复用。
下面我们以一个数组工具类为例,作一个文档说明书。
程序:
- /**
- 这是一个可以对数组进行相关操作的工具类,该类提供了取数组的最值、排序等功能。
- @author Godream
- @version V1.0
- */
- //类名权限要最大才能创建说明书文档
- public class ArrayTool
- {
- /**
- 空参数构造函数
- */
- private ArrayTool() //私有化构造函数是为了让其不能创建对象。
- {
- }
- /**
- 这个功能用于得到int类型数组中的最大值
- @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];
- }
- /**
- 这个功能用于得到int类型数组中的最小值
- @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 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);
- }
- }
- }
- /**
- 对数组中的两个元素进行位置交换
- @param arr 接收一个int类型的数组
- @param a 要置换的元素角标
- @param b 要置换的元素角标
- */
- private static void swap(int[] arr,int a,int b)
- {
- arr[a]=arr[b]+(arr[b]=arr[a])*0;
- }
- /**
- 遍历数组:打印数组中所有元素,形式为:[elemet1,elemet2,...]
- @param arr 接收一个int类型的数组
- */
- public static void printArray(int[] arr)
- {
- System.out.print("[");
- for (int x=0; x<arr.length-1; x++)
- {
- System.out.print(arr[x]+",");
- }
- System.out.println(arr[arr.length-1]+"]");
- }
- }
在dos命令行中输入命令:javadoc -d Myhelp -author-version ArrayTool.java
Java中的javadoc工具就会帮我们完成说明文档也称API的制作。
如图:
这个就是我们制作的属于自己API了: