Java基础之面向对象（二）文档注释与设计模式

最新推荐文章于 2024-03-11 20:32:19 发布

g552092947

最新推荐文章于 2024-03-11 20:32:19 发布

阅读量397

点赞数

分类专栏： Java

本文链接：https://blog.csdn.net/g552092947/article/details/46637841

版权

Java 专栏收录该内容

14 篇文章 0 订阅

订阅专栏

一、帮助文档的制作

帮助文档的制作，要先有相应的Java文件，文件中有对应的注释，其中对文档的注释用“ /** */ ”。并且.java文件有相应的注释。其中@param代表元素参数，@author表示作者， @version API版本号，@Return 返回值，下面以数组工具类ArrayTool为例。

代码示例：

package com.itheima;
/**
 * 建立一个数组工具类，用于操作数组。其中包括的函数有：获取最值，排序等
 * @author Administrator
 * @version v1.0
 */

public class ArrayTool {
	//定义一个空的构造函数，用于初始化
	private ArrayTool()
	{		
	}
	/**
	 * 获取数组中的最小值
	 * @param arr 接受一个数组类型是int的整型数组
	 * @return 返回数组中的最小值
	 */
	public static int getMin(int[] arr)
	{
		int min=0;
		for(int i=1;i<arr.length;i++)
		{
			if(arr[min]>arr[i])
				min=i;
		}
		return arr[min];
	}
	/**
	 * 获取数组中的最大值
	 * @param arr 接受一个数组类型是int的整型数组
	 * @return 返回数组中的最大值
	 */
	public static int getMax(int[] arr)
	{
		int max=0;
		for(int i=1;i<arr.length;i++)
		{
			if(arr[max]<arr[i])
				max=i;
		}
		return arr[max];
	}
	/**
	 * 对数组进行选择升序排列
	 * @param arr 接受一个数组类型是int的整型数组
	 */
	public static void suanzeSort(int[] arr)
	{
		for(int i=0;i<arr.length-1;i++)
			for(int j=i+1;j<arr.length;j++)
				if(arr[i]>arr[j])
				{
					sap(arr,i,j);
				}
	}
	/**
	 * 对数组进行冒泡降序排列
	 * @param arr 接受一个数组类型是int的整型数组
	 */
	public static void maopaoSort(int[] arr)
	{
		for(int i=0;i<arr.length;i++)
			for(int j=0;j<arr.length-i-1;j++)
				if(arr[j]<arr[j+1])
					sap(arr, j, j+1);
	}
	/**
	 * 获取指定的元素在指定数组中的索引
	 * @param arr 接受一个数组类型是int的整型数组
	 * @param key 要查找的数据
	 * @return  返回要查找元素的索引值，如果没有找到返回-1
	 */
	public static int getIndex(int[] arr,int key)
	{
		for(int i=0;i<arr.length;i++)
			if(arr[i]==key)			
				return i;
		return -1;
			
	}
	/**
	 * 将数组转换成字符串
	 * @param arr 接受一个数组类型是int的整型数组
	 * @return 返回转换为字符串后的数据
	 */
	public static String arrToString(int[] arr)
	{
		String str="[";
		for(int i=0;i<arr.length;i++)
		{
			if(i!=arr.length-1)
			{
				str=str+arr[i]+",";
			}
			else {
				str=str+arr[i]+"]";
			}
		}
		return str;
	}
	/**
	 * 进行数据交换
	 * @param arr 接受一个数组类型是int的整型数组
	 * @param i 
	 * @param j
	 */
	private static void sap(int[] arr, int i, int j) {
		// TODO Auto-generated method stub
		int a=arr[i];
		arr[i]=arr[j];
		arr[j]=a;
		
	}

}

生成帮助文档的效果图如下：

打开index.html后

需要注意的是：

1，讲一个类文档化需要类是public的。

2，类中的私有方法不会文档化，比如类中的sap函数。

二、单例设计模式

什么叫设计模式？

设计模式（Design pattern）是一套被反复使用、多数人知晓的、经过分类编目的、代码设计经验的总结。也可以理解为对问题行之有效的解决方式，它是一种思想。使用设计模式是为了可重用代码、让代码更容易被他人理解、保证代码可靠性。

Java中共有23中设计模式，这里介绍单例设计模式。

单例设计模式，确保一个类在内存中的唯一性。那么怎么确定唯一性呢？

思想：1，不能让其他程序创建该类的对象

2，在此类中创建本类对象

3，对外提供获取本类对象的方法。

具体步骤如下：

1，私有化该类的构造函数

2，在类中创建对象

3，定义公共方法返回创建的对象

代码实现如下：

（1）饿汉式：

package com.itheima;

public class SingleE {
	//私有化本类构造函数
	private SingleE(){}
	//创建本类对象，类一加载，对象就存在
	private static SingleE singleE=new SingleE();
	//定义返回类对象的函数
	public static SingleE getInstance()
	{
		return singleE;
	}	
}

（2）懒汉式：

package com.itheima;
/**
 * 延迟加载方式
 * @author Administrator
 */
public class SingleL {
	//私有化本类构造函数
	private SingleL(){}
	//创建本类对象，类一加载，没有对象存在，只有调用了getInstance方法之后摧毁创建对象
	private static SingleL singlel=null;
	//定义返回类对象的函数
	public static SingleL getInstance()
	{
		if(singlel==null)
			singlel= new SingleL();
		return singlel;
	}	
}