java：在eclipse中自定义一个工具类，并生成对应javadoc文档详解

java：在eclipse中自定义一个工具类，并生成对应javadoc文档详解

下面介绍一下一个典型的工具类编写，和在eclipse环境下的api文档的生成方法

思路：

（1）首先将无参构造私有化;

（2）定义相关方法功能（静态方法）;

（3）为代码提供注释，/** 注释内容 */

（4）选中当前代码页面，在eclipse顶部菜单中选择Project——>Generation Javadoc——>Finish;

实例：

一、新建工具类，并添加注释

//ArrayTool工具类
/**
 * 该类是自定义的针对数组操作的工具类.
 * @author 岳大翔
 * @version v1.0
 */
public class ArrayTool {
	//无参构造私有化， 目的：不让外界直接创建对象
	private ArrayTool() {
		
	}
	
	/**
	 *	该方法时针对数组遍历的功能，将数组一[元素1,元素2,...]格式输出.
	 *@param arr 需要遍历数组
	 */
	
	public static void arrayShow(int [] arr) {
		System.out.println("[");
		for(int i=0;i<arr.length;i++) {
			if(i==arr.length-1) {
				System.out.println(arr[i]+"]");
			}else {
				System.out.print(arr[i]);
			}
		}
	}
	
	/**
	 *	该方法是返回数组中的最大值.
	 *@param arr 在指定数组中获取最大值
	 *@return 返回最大值
	 */
	
	public static int getMxa(int [] arr) {
		//定义参照物
		int max=arr[0];
		for(int x=1;x<arr.length;x++) {
			if(arr[x]>max) {
				max=arr[x];
			}
		}
		return max;
	}
	/**
	 *	该方法是在指定数组中查询指定元素角标值.
	 *@param arr 在指定数组中查询
	 *@param key 要查询数组中的元素
	 *@return 如果查找到，则返回角标，如果没有，则返回-1
	 */
	
	public static int getIndex(int [] arr,int key){
		//假设实现
		int index=-1;
		for(int x=0;x<arr.length;x++) {
			if(arr[x]==key) {
				index=x;
				break;
			}
		}
		return index;
	}

}

二、在eclipse顶部菜单中选择Project——>Generation Javadoc——>Finish

确认选择所在 包保存目录无误后 Finish!

输出没有报错，成功，即可到保存目录查看doc文档

三、点击index.html查看文档

让我们来看看我们编写的文档吧！

点击方法方面名称就可以看到方法的详细解释了

根据我们注解刚刚定义的内容

我们可以很清楚看到 自动生成的doc文档 中方法的参数，返回值等内容;

到这里就算完成了！！！

最后简单介绍下常用注解

注解名称	详细解释
.@version	版本信息
.@author	作者
.@deprecated	不推荐使用的方法
.@param	方法的参数类型
.@return	方法的返回类型
.@see	用于指定参考的内容
.@exception	抛出的异常
.@throws	抛出的异常，和exception同
.@docroot	表示产生文档的根路径

铁汁，点个赞吧！