帮助文档的制作--javadoc

女爷i 2021-09-14 09:00 409阅读 0赞

上一节定义了一个静态的工具类ArrayTool：

> 如果将ArrayTool.class文件发送给其他人，其他人只要将该文件设置到classpath路径下，就可以使用该工具类。
> 
> 但是，我们却不清楚，该类中到底定义了多少个方法，因为该类并没有使用说明书。

开始制作程序的说明书，java说明书通过文档注释来完成。

> 步骤如下：
> 
> 1、首先，这是一个可以对数组进行操作的工具类，该类中提供了获取最值，排序功能。

public class Demo24 {
    
    	public static void main(String[] args) {
    
    	}
    	
    }
    
    public class ArrayTool{
    	
    	/*
    	 * 空参数构造函数
    	 * @param arr 接收一个int类型的数组。
    	 */
    	private ArrayTool() {//将构造函数私有化
    		
    	}
    	/*
    	 * 获取一个整形数组中的最大值。
    	 * @param arr 接收一个int类型的数组。
    	 * @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 接收一个int类型的数组。
    	 * @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];
    	}
    	
    	/*
    	 * 给int数组进行排序。
    	 * @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++){
    				if(arr[x]>arr[y]){
    					swap(arr, x, y);
    				}
    			}
    		}
    	}
    	
    	/*
    	 * 给int数组进行冒泡排序。
    	 * @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++){
    				if(arr[y]>arr[y+1]){
    					swap(arr, y, y+1);
    				}
    			}
    		}
    	}
    	
    	/*
    	 * 给数组中元素进行位置的置换。
    	 * @param arr 接收一个int类型的数组。
    	 * @param a 要置换的位置
    	   @param b 要置换的位置
    	 */
    	private static void swap(int[] arr,int a,int b){//没有必要让用户知道，可以私有化
    		int temp=arr[a];
    		arr[a]=arr[b];
    		arr[b]=temp;
    	}
    	
    	/*
    	 * 对数组进行打印，打印格式为[1 2 3 4 5 6]。
    	 * @param arr 接收一个int类型的数组。
    	 */
    	public static void printArray(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.print(arr[x]+"]");
    			}
    		}
    	}
    }

2 、生成帮助文档

> 先找到ArrayTool.java的根目录，在cmd中输入：javadoc -d help -version -author ArrayTool.java    注：（-d help 是存储路径，-versoin -author是版本号和作者名，这两个可要可不要，但是在生成javadoc时，类名必须是public类型的）

![Center][]

生成的文档如下：

![20171106114014689][]

一个类中默认会有一个空参数的构造函数。

这个默认的构造函数的权限和所属类一致；

如果类被public修饰，那么默认的构造函数也带public修饰符。

如果类中没有被public修饰，那么默认的构造函数，也没有public修饰。

**默认构造函数的权限是随着类的变化而变化。**

[Center]: /images/20210720/62b56b59e6cf4b629c95ac90556f122d.png
[20171106114014689]: /images/20210720/252bf605aa0f4ca1af6ca93243e5ec2b.png