【Java】文如何制作帮助文档

　

如何制作帮助文档：

 

(1)写一个类
(2)加入文档注释
(3)通过javadoc工具生成即可

 

javadoc -d 目录 -author -version ArrayTool.java

ps.

 

输入后会自动如果原文件中没有myhelp文件夹，会自动生成一个myhelp文件夹

从名称为  index.html索引页面开始观看。

会发现并无换位操作，私有的不提取，属于被保护权限

只有两种权限会在其中出现public   protect

 

为什么使用帮助文档？

 

 

静态的应用。

 

每一个应用程序中都有共性的功能，可以将这些功能进行抽取，独立封装，以便复用，

 

虽然可以通过建立ArrayTool的对象使用这些工具方法，对数组进行操作

发现问题：

1，对象是用于封装数据的，可是ArrayTool对象并未封装特有数据，

2，操作数组的每一个方法都没有用到ArrayTool对象中的特有数据。

 

这时就考虑，让程序更严谨，是不需要对象的，可以将ArrayTool中的方法都定义成static的，直接通过类名调用即。

 

将方法都静态后，可以方便与使用，但是该类还是可以被其他程序建立对象的，

为了更为严谨，强制让该类不能建立对象。可以通过将构造函数私有化完成，

 

接下来，将ArrayTool.class文件发送给其他人，其他人只要将该文件设置到classpath路径下，就可以使用该工具类，

但是，很遗憾，该类中到底定义了多少个方法，对方不清楚，因此需要使用说明书。

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

 

示例：

 

 

/**
这是一个可以对数组进行操作的工具类，该类中提供了，获取最值，排序等功能。
@author lp
@version v1.1
*/

public class ArrayTool 
{
	/**
	空参数构造函数。
	*/
	private ArrayTool(){}
	/**
	获取一个整形数组中的最大值。
	@param arr 接收一个int 类型的数组。
	@return 会返回一个该数组中最大值。
	*/
	public static int getMax(int[] arr)
	{
		int max = 0;
		for (int x = 0; 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 = 0; x<arr.length; x++)
		{	
			if(arr[x]<arr[min])
			{
				min = x;
			}
		}
		return arr[min];
	}
	
	/**
	给int数组进行选择排序。
	@param arr 接收一个int 类型的数组。
	*/

 

 

 

第一步：通过javadoc工具生成即可

javadoc -d 目录 -author -version ArrayTool.java

 

 

 

 

第二步：点击index.html即可得到说明文档：