java文档（javadoc)的制作方法和步骤

做javadoc，程序说明书，通过文档注释来完成！！！

下面代码：

package 类;
/**
 这是一个可以对数组进行操作的工具类，可以取数组的最大值和最小值。
 @author zhangshuai
 @version v1
 */
 public class ArrayTool {
     private ArrayTool(){};
     /**
      获取整形数组中的最大值；
      @param arr 接收一个数组
      @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 接收一个数组
      @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];
        
     }
}

文档生成的两种方式：用控制台javadoc 或者用eclipse或者myeclipse，

用eclipse（myeclipse一样）操作步骤：右击要生成文档的java文件---》export---》java------》javadoc-----》选择要存入的目标文件夹---》finish---打开目标文件夹就可以看到文档了！

上面代码生成的文档为：

——————————————————————————————————————————————————————————————————————————

软件包   类  使用  树  已过时  索引  帮助
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

类 
类 ArrayTool

java.lang.Object

  类.ArrayTool

---

public class ArrayTool

extends java.lang.Object

这是一个可以对数组进行操作的工具类，可以取数组的最大值和最小值。

版本：

v1

作者：

zhangshuai

---

方法摘要
static int	GetMax(int[] arr)            获取整形数组中的最大值；
static int	GetMin(int[] arr)            获取整形数组中的最小值；

 

从类 java.lang.Object 继承的方法

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

方法详细信息

GetMax

public static int GetMax(int[] arr)

获取整形数组中的最大值；

参数：

arr - 接收一个数组

返回：

返回一个该数组的最大值

---

GetMin

public static int GetMin(int[] arr)

获取整形数组中的最小值；

参数：

arr - 接收一个数组

返回：

返回一个该数组的最小值

---

软件包   类  使用  树  已过时  索引  帮助
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

——————————————————————————————————————————————————————————————————————————