java API开发文档的制作

编写一个工具类的程序：

/**
 * 
 */
//package task3;

/**该类提供了对于整形数组和double类型数组的一些方法。
 * @author 花花
 * @version V1.0
 * 
 */
public class FunctionArray{
    /*
     * 如果不定义为工具类，可以利用泛型，在仅参数类型不同时，实现代码复用。
     * public class FunctionArray<T extends java.lang.Number>
     */
    private FunctionArray() {

    }
    /**
     * 该方法是针对整型数组求和的方法
     * @param 
     *          a :需要被遍历的数组
     * @return
     *           数组元素的和
     * */
        public static int sum(int a[])
        {
            int sum=0;
            for(int i=0;i<a.length;i++)
            {
                 sum=sum+a[i];
            }
            return sum;
        }
        /**
         * 该方法是针对double型数组求和的方法
         * @param 
         *          a :需要被遍历的数组
         * @return
         *           数组元素的和
         * */
        public static double sum(double a[])
        {
            double sum=0;
            for(int i=0;i<a.length;i++)
            {
                 sum=sum+a[i];
            }   
            return sum;
        }
        /**
         * 该方法是针对int型数组获取最大值的方法
         * @param 
         *          a :需要被遍历的 数组,可以获取每一个元素
         * @return
         *          返回的就是数组中最大值
         * 
         * */

        public static int max(int a[])
        {
            for(int i=0;i<a.length-1;i++)
            {
                for(int j=i+1;j<a.length;j++)
                {
                    if(a[i]>a[j])//升序：由小到大
                    {
                        int temp=a[i];
                        a[i]=a[j];
                        a[j]=temp;
                    }
                }       
            }
            return a[a.length-1];   
        }
        /**
         * 该方法是针对double型数组获取最大值的方法
         * @param 
         *          a:需要被遍历的 数组,可以获取每一个元素
         * @return
         *          返回的就是数组中最大值
         * 
         * */

        public static double max(double a[])
        {
            for(int i=0;i<a.length-1;i++)
            {
                for(int j=i+1;j<a.length;j++)
                {
                    if(a[i]>a[j])//升序：由小到大
                    {
                        double temp=a[i];
                        a[i]=a[j];
                        a[j]=temp;
                    }
                }       
            }
            return a[a.length-1];   
        }
        /**
         * 该方法是针对int型数组进行升序排列的方法
         * @param a
         * 需要排序的数组
         * 
         */
        /*3.对数组进行升序排序.
         * 选择排序：最多n-1趟。比较次数最多1/2(n^2-n). T(n)=O(n^2)*/
        public static void sortByAsce(int a[])
        {

            for(int i=0;i<a.length-1;i++)
            {
                for(int j=i+1;j<a.length;j++)
                {
                    if(a[i]>a[j])//升序：由小到大
                    {
                        int temp=a[i];
                        a[i]=a[j];
                        a[j]=temp;
                    }
                }       
            }   
        }
        /**
         * 该方法是针对duoble数组进行升序排列的方法
         * @param a
         * 要进行排序的数组
         * 
         */
        public static void sortByAsce(double a[])
        {

            for(int i=0;i<a.length-1;i++)
            {
                for(int j=i+1;j<a.length;j++)
                {
                    if(a[i]>a[j])//升序：由小到大
                    {
                        double temp=a[i];
                        a[i]=a[j];
                        a[j]=temp;
                    }
                }       
            }   
        }
        /**
         * 该方法是针对int型数组进行逆序排列的方法
         * @param a
         * 要进行排列的数组
         */
        public static void back(int a[])
        {/*4,数组元素逆序 (就是把元素对调)
             * 令n=a.length
             */
            if(a.length%2==0)//n为偶数
            {
             for(int i=0,j=a.length-1;(i<a.length/2)&&(j>=a.length/2);i++,j--)
              {
                int temp=a[i];
                a[i]=a[j];
                a[j]=temp;
              }     
            }
            else//n为奇数，a[n/2]不进行交换//如：n=5  0,1,2,3,4
            {
                for(int i=0,j=a.length-1;(i<a.length/2)&&(j>a.length/2);i++,j--)
                  {
                    int temp=a[i];
                    a[i]=a[j];
                    a[j]=temp;
                  }       
            }
        }//back方法结束
        /**
         * 该方法是针对double型数组进行逆序排列的方法
         * @param a
         * 要进行排列的数组
         */
        public static void back(double a[])
        {
            if(a.length%2==0)//n为偶数
            {
             for(int i=0,j=a.length-1;(i<a.length/2)&&(j>=a.length/2);i++,j--)
              {
                double temp=a[i];
                a[i]=a[j];
                a[j]=temp;
              }     
            }
            else//n为奇数，a[n/2]不进行交换//如：n=5  0,1,2,3,4
            {
                for(int i=0,j=a.length-1;(i<a.length/2)&&(j>a.length/2);i++,j--)
                  {
                    double temp=a[i];
                    a[i]=a[j];
                    a[j]=temp;
                  }       
            }
        }//back方法结束

        /**
         * 该方法是针对int型数组进行遍历的方法，输出数组的每一个元素
         * @param a
         * 需要进行遍历的数组
         */
        public static void print(int a[])
        {
            for(int i=0;i<a.length;i++)
            {
                System.out.print(a[i]+" ");
            }   
        }
        /**
         * 该方法是针对double型数组进行遍历的方法
         * @param a
         * 需要进行遍历的数组
         * 
         * */
        public static void print(double a[])
        {
            for(int i=0;i<a.length;i++)
            {
                System.out.print(a[i]+" ");
            }   
        }   

}

打开dos—->javadoc -d 目标名(文件名) -author -version XX.java

此时生成了一个数组工具的文件夹，打开这个文件夹，找到index.html就可以看到自己制作的API文档了。