Java学习个人备忘录之文档注释

文档注释
单行注释用 //

多行注释有两种，第一种是 /* 内容 */，第二种是/** 内容 */。

这两种多行注释的区别是/** 内容 */这种注释可以生成一个该文件的注释文档，下面是演示代码。

ArrayTool.java文件

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

//ArrayTool.java文件
public class ArrayTool //加上public后,文件名和类名要一致
{
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)
{
int temp = arr[a];
arr[a] = arr;
arr[b] = arr[a];
}

/**
获取指定的元素在指定数组中的索引.
@param arr 接收一个元素为int类型的数组
@param key 要找的元素.
@return 返回来元素第一次出现的位置, 如果不存在返回-1.
*/
public static int getIndex(int[] arr,int key)
{
for (int x=0; x<arr.length ; x++ )
{
if (arr[x]==key)
{
return x;
}
}
return -1;
}

/**
将int数组转成字符串. 格式为: [e1,e2,e3,....]
@param arr 接收一个元素为int类型的数组
@return 返回该数组的字符串表现形式.
*/
public static String arrayToString(int[] arr)
{
String str = "[";
for (int x=0; x<arr.length ; x++ )
{
if (x != arr.length-1)
str = str + arr[x] + ", ";
else
str = str + arr[x] + "]";
}
return str;
}
}

[b]ArrayToolDemo.java文件

class ArrayToolDemo
{
public static void main(String[] args)
{
int[] arr = {4,8,2,9,7,6};

// ArrayTool tool = new ArrayTool();

int max = ArrayTool.tool.getMax(arr);
System.out.println("max="+max);

int index = ArrayTool.tool.getIndex(arr,10);
System.out.println("index="+index);
}
}

 

ArrayTool.java文件已经写好了，现在我们使用命令生成ArrayTool.java文件的注释文档。

用法：javadoc [选项] [软件包] [源文件] [@file]
javadoc [参数可以是多个] [存放的路径] [源文件] [描述]

例：javadoc -d myhelp -author -version ArrayTool.java