Java学习 文档注释

所操作的类必须是共有的才能进行文档注释

javadoc只能对public修饰或protect修饰函数方法进行提取注释

因为我们文档注释是为了让用户看到函数方法的使用，而我们之所以给一些函数private权限就是为了将细节

隐藏起来，所以文档注释不对private的函数方法进行提取注释。

/**
这就是文档注释！
悠悠华
*/

文档注释的内容很多，我们现在只需要几个基础的

@author  这是注明类的作者

@version 这是注明版本号

@param 这是注明变量

@return这是注明返回值

下面我们一个例子来具体展示文档注释：

/**
这是一个数组工具类，存放一些函数方法，如冒泡排序，选择排序，查找数组元素。。。
@author 悠悠华
@version 1.0
*/
public class Arr
{
	private Arr(){}
	
	
	
	/**
	冒泡排序
	@param arr 传递一个数组
	*/
	public static void bubbleSort(int[] arr)
	{
		for(int x = 0;x<arr.length-1;x++)
		{
			for(int y = 0;y<arr.length-1-x;y++)
			{
				if(arr[y] > arr[y+1])
				{
					int temp = arr[y];
					arr[y] = arr[y+1];
					arr[y+1] = temp;
				}
			}
		}
	}
	
	/**
	选择排序
	@param arr 传递一个数组
	*/
	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])
				{
					int temp = arr[x];
					arr[x] = arr[y];
					arr[y] = temp;
				}
			}
		}
	}
	
	/**
	打印函数
	@param arr 传递一个数组
	*/
	public static void print(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]+",");
		}
		System.out.println();
	}
	
	
	/**
	查找指定元素的下标
	@param arr 传递一个数组
	@param key 所要查找的元素值
	@return 如果存在索要查找的数据，就将此数据的下标返回，否则返回-1
	*/
	public static int search(int[] arr,int key)  //普通查找 数组有序无序均可
	{
		for(int x = 0;x<arr.length;x++)          //遍历整个数组
		{
			if(arr[x] == key)					 //如果相等就返回下标
			{
				return x;
			}
		}
		return -1;								 //如果数组中不存在此元素则返回-1
	}
	/**
	二分查找（哈希查找）
	@param arr 传递一个数组
	@param key 所要查找的值
	@return 如果存在索要查找的数据，就将此数据的下标返回，否则返回-1
	*/
	public static int halfSearch(int[] arr,int key) //不与系统的折半查找重名 随便起的
	{
		int min = 0;								//最小值下标 初值为0
		int max = arr.length-1;						//最大值下标 初值为长度减一
		int mid = (min+max)/2;						//中间值下标 初值为 (min + max) / 2
		while(min<=max)								//最小值下标肯定小于最大值下标 如果不满足说明没有找到此元素 所以return -1;
		{
			if(key>arr[mid])						//如果查找的值大于中间值 我们将最小值移到中间值右侧
			{
				min = mid+1;
				mid = (min+max)/2;
			}
			if(key<arr[mid])						//如果查找的值小于中间值，我们将最大值移到中间值左侧
			{
				max = mid -1;
				mid = (min+max)/2;
			}
			if(key == arr[mid])						//如果相等则返回其下标
				return mid;
		}
		return -1;
	}
	
}
	

然后我们需要使用javadoc来生成注释文档，在这里我们需要注意，我们所要生成注释文档的类的权限必须是public的，不然会报错。

下面才是对的===================================<*.*>

生成了这么多文件，我们都不用管，只管打开index.html

这样一个大体的文档注释就写好了。