制作类的帮助文档

当你在编写了一个工具类，希望别人在调用你的类的时候，而不希望他人看到你的源代码，这就需要一个说明书来说明你的类中有那些函数和这些函数的要接收的参数，以及函数的功能，一下是关于帮助文档的手动制作。（一些高级工具可以自动生成这些东西）

1、首先在类中定义的函数以及类必须是public公用的

2、其次用/**内容*/格式在所要说明的函数上边进行对函数描述

3、上边的内容有一些特定的关键字来描述特定的内容，一下简单介绍（想要更多的找度娘）

　　@author 作者

　　@version 版本

　　@param 变量

　　@return 返回值

一下是一个简单的代码举例

 1 /**
 2 此类定义了一系列对Int数组处理的函数
 3 @author fantasy
 4 @version v1.0
 5 */
 6 public class ArrayDeal
 7 {
 8     private ArrayDeal(){}
 9     /**
10         获取int数组的最大值
11         @param arr 接收一个int型数组
12         @return 返回数组最大值
13     */
14     public static int getMax(int[] arr)
15     {
16         int max = arr[0];
17         for(int x=1; x<arr.length; x++)
18         {
19             if(arr[x]>max)
20                 max = arr[x];
21         }
22         return max;
23     }
24     /**
25         获取int数组的最小值
26         @param arr 接收一个int型数组
27         @return 返回数组最小值
28     */
29     public static int getMin(int[] arr)
30     {
31         int min = arr[0];
32         for(int x=1; x<arr.length; x++)
33         {
34             if(arr[x]<min)
35                 min = arr[x];
36         }
37         return min;
38     }
39     /**
40         对数组进行排序
41         @param arr 接收一个int型数组
42     */
43     public static void sort(int[] arr)
44     {
45         for(int i=0; i<arr.length-1; i++)
46         {
47             for(int j=i+1; j<arr.length; j++)
48                 if(arr[i]>arr[j])
49                     swap(arr, i, j);
50         }
51     }
52     /**
53         交换数组中俩数的位置
54         @param arr  接收一个int型数组
55         @param a   元素位置
56         @param b   元素位置
57     */
58     public static void swap(int[] arr, int a, int b)
59     {
60         int temp = arr[a];
61         arr[a] = arr[b];
62         arr[b] = temp;
63     }
64     /**
65         打印数组
66     */
67     public static void printArray(int[] arr)
68     {
69         System.out.print("[");
70         for(int i=0; i<arr.length; i++)
71             System.out.print(arr[i]+",");
72         System.out.print("]
");
73     }
74 }

View Code

4、接下来这是借助jdk中in目录下的javadoc来生成帮助文档（网页形式）注意此处是用文本编的代码

打开命令提示窗口进入代码文本所在目录输入 javadoc -d -author -version help ArrayDeal.java

-d 指目录即directory

-author 获取作者

-version 获取版本号

注意若无-author -version,帮助文档中不会有作者和版本号

help 是在当前目录下建立一个help文件夹来存生成的网页，当然也可以自己定义路径如：c:help

ArrayDeal.java 是代码所在的文本

接下来就在help文件夹中生成了一对网页，打开index就可以查看了