Java之利用javadoc生成注释文档

Java里面可以使用javadoc.exe（与javac.exe 和java.exe在同一个目录下）生成代码的注释文档。这是java特有的小工具。

举个小例子：

Demo.java

/**
建立一个用于操作数组的工具类，其中包含着常见的对数组操作的函数如：最值，排序等。
@author 张三
@version v1.0
*/

public class ArrayTool
{
//该类中的方法都是静态的，所以该类是不需要创建对象的，为了保证不让其他人创建该类对象，可以将构造函数私有化。
private ArrayTool()
{

}

/**
获取整数数组的最大值
@param arr 接受一个元素为int类型的数组
@return 该数组的最大元素值。
*/
public static int getMax(int[] arr)
{
int maxIndex = 0;
for(int x = 1; x < arr.length; x++)
{
if(arr[x]>arr[maxIndex])
maxIndex = x;
}
return arr[maxIndex];
}
/**
对数组进行选择排序
@param arr 接受一个元素为int类型的数组
*/
public static void selectSort(int[] arr)
{
for(int x = 0; x<arr.length-1; x++)
{
for(int y = x+1; y < arr.length; y++)
{
if(arr[x] > arr[y])
swap(arr, x, y);
}
}
}
/**
给数组进行元素的位置置换
@param arr 接受一个元素为int类型的数组
@param a 元素的索引
@param b 元素的索引
*/
private static void swap(int[] arr, int a, int b)
{
if(arr == null)
return;
if(a < 0 || a >= arr.length)
return;
if(b < 0 || b >= arr.length)
return;
int temp = arrp[a];
arr[a] = arr;
arr[b] = temp;
}
}

如何生成javadoc文档？

然后我们执行javadoc命令：[b]javadoc -d myhelp -author -version ArrayTool.java 


简单来说，就是说提取ArrayTool.java代码的注释文档，提取的包含字段为用@author 和@version标示的注释部分，最终保存在myhelp目录下面。



之后，我们可以看到在源代码的同级目录出现了myhelp文件夹，里面包含了注释文档。



打开之后，我们找到index.html文档，打开浏览即可。

注意事项：

1 如果没有myhelp这个目录，会在ArrayTool.java文件所在的目录建立一个myhelp目录。

2 提取的都是公有public的方法，private方法的注释无法提取到文档中。

3 只有 /**  */ 格式的注释可以提取出来，但是 /* */
和 // 这种格式的提取不出来。