Java学习笔记——生成doc说明文档的方法

//在Java中我们有时候会用到Java给我们提供的各种方法，例如冒泡排序，获得字符串长度等，这些方法如果不加以说明的话，我们是很难搞明白如何用这些方法，比如方法的参数所起的作用等。。。所以开发人员会为自己写好的类和方法写一个帮助文档，让用的人看。下面是一段代码，我会用这段代码生成一个帮助文档。

/**
这是一个工具类，获得数组最值的功能
@author 李翰超
@version v1.0


*/

public class ArrayTool 
{
/**
空参数构造函数


*/
ArrayTool(){}
/**
获取一个整型数组的最值
@param  arr 接收一个int类型的数组


*/
public static void getMax(int[] arr){
int max=arr[0];
for (int x=1;x<arr.length ;x++ )
{
if (max>=arr[x])
{

}else
{
max=arr[x];
}


}
System.out.println(max);

}
}

将自己想要表达的意思，对代码的解释写到注释中去，其中带@符号的单词是一些文档中的特殊字段，生成文档时系统会自动识别，下面将在cmd中输入如下语句：

然后等待文件生成，你就会在你的Java文件存放的目录下看到一个叫mydoc1 的文档，打开，如图，

直接打开index 文件，就可以看到你想要生成的文档了~~

注意！ 如果你想让文档生成到其他位置，可以这样在cmd中写：javadoc -df:\mydoc2 -author -version ArrayDemo.java即可