JAVASE如何制作帮助文档

JAVASE如何制作帮助文档
(1)写一个类
(2)加入文档注释
(3)通过javadoc工具生成即可
javadoc -d 目录 -author -version ArrayTool.java

例子:

ArrayDemo.java

/*
我想要对数组进行操作

如何制作一个说明书呢?
A:写一个工具类
B:对这个类加入文档注释
怎么加呢?
加些什么东西呢?
C:用工具解析文档注释
javadoc工具
D:格式
javadoc -d 目录 -author -version ArrayTool.java

目录：就可以写一个文件夹的路径

制作帮助文档出错：
找不到可以文档化的公共或受保护的类：告诉我们类的权限不够
*/
class ArrayDemo {
public static void main(String[] args) {
//定义数组
int[] arr = {28,55,37,46,19};

//遍历
ArrayTool.printArray(arr);

//获取最值
int max = ArrayTool.getMax(arr);
System.out.println(“max:”+max);

//获取55的索引值
int index = ArrayTool.getIndex(arr,55);
System.out.println(“index:”+index);
}
}

ArrayTool.java

/**
* 这是针对数组进行操作的工具类
* @author 刘意
* @version V.10
*/
public class ArrayTool {

//把构造方法私有，外界就不能在创建对象了
/**
* 这是私有构造
*/
private ArrayTool(){}

/**
* 这是遍历数组的方法，遍历后的格式是：[元素1, 元素2, 元素3, …]
* @param arr 这是要被遍历的数组
*/
public static void printArray(int[] arr) {
System.out.print(“[“);
for(int x=0; x<arr.length; x++) {
if(x == arr.length-1) {
System.out.println(arr[x]+”]”);
}else {
System.out.print(arr[x]+”, “);
}
}
}

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

for(int x=1; x<arr.length; x++) {
if(arr[x] > max) {
max = arr[x];
}
}

return max;
}

/**
* 获取指定元素在数组中第一次出现的索引，如果元素不存在，就返回-1
* @param arr 被查找的数组
* @param value 要查找的元素
* @return 返回元素在数组中的索引，如果不存在，返回-1
*/
public static int getIndex(int[] arr,int value) {
int index = -1;

for(int x=0; x<arr.length; x++) {
if(arr[x] == value) {
index = x;
break;
}
}

return index;
}
}