java怎么制作api文档（下一个笔记里面有，但是感觉比较有用，所以单独提出来）

引自：http://blog.csdn.net/kangmiao89757/article/details/10656473

静态的应用——文档说明书。

        每一个应用程序中都有共性的功能，可以将这些功能进行抽取，独立封装。以便复用。

下面我们以一个数组工具类为例，作一个文档说明书。

程序：

[java]  view plain copy

1. /** 
2. 这是一个可以对数组进行相关操作的工具类，该类提供了取数组的最值、排序等功能。 
3. @author Godream 
4. @version V1.0 
5.  
6. */  
7. //类名权限要最大才能创建说明书文档  
8. public class ArrayTool   
9. {  
10.     /** 
11.     空参数构造函数 
12.     */  
13.     private ArrayTool() //私有化构造函数是为了让其不能创建对象。  
14.     {  
15.       
16.     }  
17.   
18.     /** 
19.     这个功能用于得到int类型数组中的最大值 
20.     @param arr 接收一个int类型的数组 
21.     @return 返回接收的该数组的最大值 
22.     */  
23.     public static int getMax(int[] arr)  
24.     {  
25.         int max=0;  
26.         for (int x=1;x<arr.length ;x++ )  
27.         {  
28.             if(arr[x]>arr[max])  
29.                 max=x;  
30.         }  
31.         return arr[max];  
32.     }  
33.       
34.     /** 
35.     这个功能用于得到int类型数组中的最小值 
36.     @param arr 接收一个int类型的数组 
37.     @return 返回该数组的最小值 
38.     */  
39.     public static int getMin(int[] arr)  
40.     {  
41.         int min=0;  
42.         for (int x=1;x<arr.length ;x++ )  
43.         {  
44.             if(arr[x]<arr[min])  
45.                 min=x;  
46.         }  
47.         return arr[min];  
48.     }  
49.   
50.     /** 
51.     对int类型数组进行选择升序排列 
52.     @param arr 接收一个int类型的数组 
53.     */  
54.     public static void selectSort(int[] arr)  
55.     {  
56.         for (int x=0;x<arr.length-1 ; x++)  
57.         {  
58.             for (int y=x+1; y<arr.length; y++)  
59.             {  
60.                 if(arr[x]>arr[y])  
61.                     swap(arr,x,y);  
62.             }  
63.         }  
64.     }  
65.   
66.     /** 
67.     对int类型数组进行冒泡升序排列 
68.     @param arr 接收一个int 类型数组 
69.     */  
70.     public static void bubbleSort(int[] arr)  
71.     {     
72.         for (int x=0;x<arr.length-1;x++ )  
73.         {  
74.             for (int y=0;y<arr.length-x-1;y++ )  
75.             {     
76.                 if(arr[y]>arr[y+1])  
77.                     swap(arr,y,y+1);  
78.             }  
79.         }  
80.     }  
81.   
82.     /** 
83.     对数组中的两个元素进行位置交换 
84.     @param arr 接收一个int类型的数组 
85.     @param a 要置换的元素角标 
86.     @param b 要置换的元素角标 
87.     */  
88.     private static void swap(int[] arr,int a,int b)  
89.     {  
90.         arr[a]=arr[b]+(arr[b]=arr[a])*0;  
91.     }  
92.   
93.     /** 
94.     遍历数组：打印数组中所有元素，形式为：[elemet1,elemet2,...] 
95.     @param arr 接收一个int类型的数组 
96.     */  
97.     public static void printArray(int[] arr)  
98.     {  
99.         System.out.print("[");  
100.         for (int x=0; x<arr.length-1; x++)  
101.         {  
102.             System.out.print(arr[x]+",");  
103.         }  
104.         System.out.println(arr[arr.length-1]+"]");  
105.     }  
106. }  

在dos命令行中输入命令：javadoc -d Myhelp -author-version ArrayTool.java

Java中的javadoc工具就会帮我们完成说明文档也称API的制作。

如图：

这个就是我们制作的属于自己API了：