制作帮助文档

对于帮助文档我是不陌生的，记得第一次看帮助文档的时候是看微软的MSDN，那我们自己如何制作帮助文档呢，学了Java后，可以使用Java制作帮助文档

我就以使用Java中的数组的操作为例来制作帮助文档，在常用的数组操作中有遍历数组、获取数组中的最大的元素、指定元素在数组中的位置等操作，

首先建立一个ArrayTool.java的文件，并在文件中添加下面的代码

/**
*这是对数组操作的工具类
*@author 梅沙小子
*@version V1.0
*/
public class ArrayTool
{
/**
*这是私有构造方法
*/
private ArrayTool()
{
}

/**
*这是遍历数组的方法，遍历后的格式是:[元素1,元素2,元素3,,.....]
*@param arr 这是要被遍历的数组
*/
public static void printArray(int [] arr)
{
System.out.println("[");

for(int x = 0; x < arr.length; x++)
{
if(x == arr.length - 1)
{
System.out.print(arr[x]);
}
else
{
System.out.print(arr[x] + ", ");
}

System.out.println("]");
}
}

/**
*这是获取数组中最大值的方法
*@param arr 这是要获取最大值的数组
*@return 返回数组中的最大值
*/
public static int getMax(int [] arr)
{
int max =0;

for(int i =0; 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(value == arr[i])
{
index = i;
break;
}
}

return index;
}
}
然后建立一个文件夹用于保存帮助文件

最后在命令行中输入下面的命令，并且要保证命令在ArrayTool.java所在的目录下执行

javadoc -d E:\game\JavaCode\ArrayTool操作说明文档 -author -vers
ion ArrayTool.java
-d后面跟的是帮助文档的保存路径

出现下图所示的效果表示成功的制作了一份帮助文档



打开帮助文档保存的文件夹，可以看到文件夹下生成了一大堆文件



打开文件夹中的index.html文件，可以通过这个文件查看制作好的帮助文档