Java文档注释

Java中已经自带文档注释工具:

JDK——>bin——>Javadoc.exe。

注释格式: 

/**

注释内容............................

*/


/**
建立一个用于操作数组的工具类,其中包含着常见的对数组操作的函数如:最值,排序等 。
@author 张三
@version V1.0
*/

public class ArrayTool
{
	private ArrayTool(){}//该类中的方法都是静态的,所以该类是不需要的创建对象的。为了保证不让其他成创建该类对象
						//可以将构造函数私有化。

	/**
	获取整型数组的最大值。
	@param arr 接收一个元素为int类型的数组。
	@return 该数组的最大的元素值
	*/
	public static int getMax(int[] arr)
	{
		int maxIndex = 0;
		for(int x=1; x<arr.length; x++)
		{
			if(arr[x]>arr[maxIndex])
					maxIndex = x;//
		}

		return arr[maxIndex];
	}
	/**
	对数组进行选择排序。
	@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);
			}
		}
	}

	/*
	用于给数组进行元素的位置置换。
	@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;
	}
	
	/**
	获取指定的元素在指定数组中的索引.
	@param arr 接收一个元素为int类型的数组。
	@param key 要找的元素。
	@return 返回该元素第一次出现的位置,如果不存在返回-1.
	*/
	public static int getIndex(int[] arr,int key)
	{
		for(int x=0; x<arr.length; x++)
		{
			if(arr[x]==key)
				return x;
		}
		return -1;
	}

	/**
	将int数组转换成字符串。格式是:[e1,e2,...]
	@param arr 接收一个元素为int类型的数组。
	@return 返回该数组的字符串表现形式。 
	*/
	public static String arrayToString(int[] arr)
	{
		String str = "[";

		for(int x=0; x<arr.length; x++)
		{
			if(x!=arr.length-1)
				str = str + arr[x]+", ";
			else
				str = str + arr[x]+"]";
		}
		return str;
	}
}
扫描二维码关注公众号,回复: 2439629 查看本文章

猜你喜欢

转载自blog.csdn.net/zhanshixiang/article/details/81218046