java 简单的工具类帮助文档的编写

 简单的java帮助文档编写方法
 01  被编写的类一定要被public 修饰
 02  注释的格式是  /**  */
 03    @param  参数 @return 作者
 04    命令是 javadoc -d (当前文件夹) 文件名 -author（作者）-version （版本）  .java文件

 如下

/**
这是一个可以对数组操作的工具类
@author  小武
@version v1.1
*/
public class  ArrayTool 
{
/**
空参数的构造函数
*/
private ArrayTool(){}
/**
这个是获取数组的最大值
@param arr 接收一个int 类型的数组
@return 会返回该数组的最大值
*/
public static int getMax(int[] arr)
    {

} 


}