java说明书怎么制作

如何制作说明书呢？

1.下面这个图是制作过程

2.下面用一个例子来演示，我自己写了一个类，并且已经写好了注释

/**
* 这是针对数组进行操作的工具类
* @author 徐金鹏
* @version v.1
*/
class ArrayTool{
	private ArrayTool(){}
	/**
	* 这是遍历数组的方法，遍历后的元素：元素1，元素2，元素3...
	*@param arr 这是被遍历的数组
	*/
	public static void printArray(int[] arr){
		for(int i=0;i<arr.length;i++){
			if(i==arr.length-1){
				System.out.print(arr[i]);
			}else{
				System.out.print(arr[i]+",");
			}
		}
	}
	/**
	* 这是寻找数组最大值得方法
	*@param arr 获取数组的最大值
	*@return 返回数组的最大值
	*/
	public static int getMax(int[] arr){
		int max=arr[0];
		for(int i=1;i<arr.length;i++){
			if(arr[i]>max){
				max=arr[i];
			}
		}
		return max;
	}
	/**
	* 获取元素在数组中出现第一次的时候的索引，如果不存在就返回-1
	*@param arr 被查找的数组
	*@param value 要查找的值
	*@return 返回在数组中的索引，如果不存在，就返回-1
	*/
	public static int getIndex(int[] arr,int value){
		int index=-1;
		for(int i=0;i<arr.length;i++){
			if(arr[i]==value){
				index=i;
			}
		}
		return index;
	}
	
}

3.运行命令javadoc -d . -author -version ArrayTool.java。【.表示在当前目录】，发现有错

4.看到错误之后发现，原来是在class前面少了一个public.改正后代码

/**
* 这是针对数组进行操作的工具类
* @author 徐金鹏
* @version v.1
*/
public class ArrayTool{
	private ArrayTool(){}
	/**
	* 这是遍历数组的方法，遍历后的元素：元素1，元素2，元素3...
	*@param arr 这是被遍历的数组
	*/
	public static void printArray(int[] arr){
		for(int i=0;i<arr.length;i++){
			if(i==arr.length-1){
				System.out.print(arr[i]);
			}else{
				System.out.print(arr[i]+",");
			}
		}
	}
	/**
	* 这是寻找数组最大值得方法
	*@param arr 获取数组的最大值
	*@return 返回数组的最大值
	*/
	public static int getMax(int[] arr){
		int max=arr[0];
		for(int i=1;i<arr.length;i++){
			if(arr[i]>max){
				max=arr[i];
			}
		}
		return max;
	}
	/**
	* 获取元素在数组中出现第一次的时候的索引，如果不存在就返回-1
	*@param arr 被查找的数组
	*@param value 要查找的值
	*@return 返回在数组中的索引，如果不存在，就返回-1
	*/
	public static int getIndex(int[] arr,int value){
		int index=-1;
		for(int i=0;i<arr.length;i++){
			if(arr[i]==value){
				index=i;
			}
		}
		return index;
	}
	
}

5.再次运行这个命令，成功了

6.在这个文件里就是说明书了，双击index.html,就可以看到了


7，方法名是直接点的，是一个超链接


8.制作完成