下面用一个例子来讲解下
/**
这是一个数组工具类,立案封装了查找数组最大值,打印数组,反转数组的方法
@author Paul
@version v1.0
*/
public class ArrayTool {
/**
私有构造方法
*/
private ArrayTool(){} //如果一个类中所有的方法都是静态的,需要私有构造方法,
//即只能通过类名访问,不可以创建对象访问
//获取最大值
/**
这是获取数组中最大值的方法
@param arr 接受一个int类型的数组
@return 这是返回数组中的最大值
*/
public static int getMax(int[] arr){
int max = arr[0];
for(int i=1; i <arr.length ; i++){
if(max < arr[i]){
max = arr[i];
}
}
return max ;
}
//数组的遍历
/**
这是遍历数组的方法
@param arr 接受一个int类型的数组
*/
public static void print(int[] arr){
for(int i=0; i < arr.length ; i++){
System.out.print(arr[i]+ " ");
}
}
//数组的反转
/*
这是数组反转的方法
@param arr 接受一个int类型的数组
*/
public static void rev(int[] arr){
for(int i=0; i < arr.length ; i++){
System.out.print(arr[arr.length - 1 - i]+ " ");
}
}
}
上面是一个工具类,将文档说明写在“/** */”中,其中@author作者,@version版本,@param参数,@return返回。
文档写好后,在本目录下(即本类ArrayTool.java的目录)shift+鼠标右键打开dos窗口,如图所示
输入javadoc -d api -version -author ArrayTool.java,-d 代表在本目录下生成文档,api是文件名称,-version显示版本,-author显示作者,ArrayTool.java是类的名称。回车出现如图即生成成功。成功后打开文件,打开index.html即可。