Java之接口文档生成

旧城等待， 2023-02-24 03:48 21阅读 0赞

## 接口注释 ##

/** 操作数组的工具类，内含获取最值、数组排序、数组打印等方法 @author star @version 1.1 */
    public class ArrayTool { 
    	/** 将构造函数私有化，防止外部创建对象 */
    	private ArrayTool(){ };
    	/** 获取数组中的最大值 @param arr 接收一个int类型的数组 @return 会返回数组中的最大值 */
    	public static int getMax(int[] arr){ 
    		int max = 0;
    		for(int x = 0; x < arr.length; x++){ 
    			if(arr[x]>arr[max])
    				max = x;
    		}
    		return arr[max];
    	}
    	/** 获取数组中的最小值 @param arr 接收一个int类型的数组 @return 会返回数组中的最小值 */
    	public static int getMin(int[] arr){ 
    		int min = 0;
    		for(int x = 0; x < arr.length; x++){ 
    			if(arr[x]<arr[min])
    				min = x;
    		}
    		return arr[min];
    	}
    	/** 数组冒泡排序 @param arr 接收一个int类型的数组 */
    	public static void bubbleSort(int[] arr){ 
    		for(int x = 0; x < arr.length - 1; x++){ 
    			for(int y = 0; y < arr.length - x - 1; y++){ //减1的目的是防止最后y越界
    				samp(arr,y,y+1);
    			}
    		}
    	}
    	/** 数组选择排序 @param arr 接收一个int类型的数组 */
    	public static void selectSort(int[] arr){ 
    		for(int x = 0; x < arr.length - 1; x++){ 
    			for(int y = x + 1; y < arr.length; y++){ 
    				samp(arr,x,y);
    			}
    		}
    	}
    	/** 交换数组中两个元素的位置 @param arr 接收一个int类型的数组 @param x 元素的位置 @param y 元素的位置 */
    	private static void samp(int[] arr, int x, int y){ 
    		if(arr[x]>arr[y]){ 
    			int temp = arr[x];
    			arr[x] = arr[y];
    			arr[y] = temp;
    		}
    	}
    	/** 打印数组，输出格式为[元素1,元素2] @param arr 接收一个int类型的数组 */
    	public static void printArr(int[] arr){ 
    		System.out.print("[");
    		for(int x = 0; x < arr.length; x++){ 
    			if(x!=arr.length-1)
    				System.out.print(arr[x]+",");
    			else
    				System.out.println(arr[x]+"]");
    		}
    	}
    }

## javadoc生成 ##

javadoc -encoding UTF-8 -d myhelp -author -version ArrayTool.java

## 结果显示 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDk3MDk4Nw_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDk3MDk4Nw_size_16_color_FFFFFF_t_70]: /images/20230209/93b3c02dee1044838d33de2cf667026e.png