帮助文档(API)--制作工具类

示例：制作数组工具类（ArrayTool）

格式：

/**         工具类要把无参构造方法私有化然后工具类的方法用static修饰
  *         这样别人在使用时就只能通过类名来调用你的工具类的方法了.
  *
  *格式：
  *   首先在最前面通过文档注释写出这是一个具有什么功能的工具类
  *   然后加上   @author 作者名    @version 版本号--版本号前面一般会有一个V
  * 
  * 例如：
  *
 * 这是针对数组相关操作的工具类(还在补充优化中)
 *
 * @author 深情
 * @version V1.0
 *
 */
public class ArrayTool {
  
/**
  *每个方法前面都要写上方法的简介
  *还有需要传入的参数和返回值的简介
  *
  *格式：
  *@param 要传入的参数的简介
  *@return 返回值的简介
  *
  *例如：
  *
  *  这是私有的无参构造方法
  */
    private ArrayTool(){

    }


/**
  *每个方法前面都要写上方法能实现什么功能和方法简介
  *还有需要传入的参数类型和返回值类型以及他们的简介
  *
 *例如：
 *这是遍历数组的方法，遍历后的格式是[元素1,元素2,...]
 * @param array 这是调用方法时传入的参数，数据类型是int类型的数组
 */
    public static void printArray(int[] array){
        for (int i = 0; i < array.length; i++) {
            if (i == 0) {
                System.out.print("[" + array[i] + ",");
            } else if (i == array.length - 1) {
                System.out.print(array[i] + "]");
            } else {
                System.out.print(array[i] + ",");
            }
        }
    }


    /**
     *例如：
     * 这是获取数组元素中最大值的方法
     * @param array 这是调用该方法需要传入的参数，数据类型是int类型的数组
     * @return 返回的是该数组中元素的最大值
     */
    public static int getMaxNum(int[] array){
        int max = array[0];
        for (int i = 1; i < array.length; i++) {
            if (array[i] > max) {
                max = array[i];
            }
        }
        return max;
    }
}