黑马程序员------毕老师视频笔记第六天------面向对象（javadoc文档的制作）

---------------------- ASP.Net+Unity开发、.Net培训、期待与您交流！ ----------------------

假设有一个工具类ArrayTool，将ArrayTool.class文件发送给其他人，其他人只要将该文件设置到classpath路径下，就可以使用该工具类。但是，很遗憾，该类中到底定义了多少个方法，对方并不清楚，因为该类没有使用说明书。java的说明书通过文档注释来完成。

/**
这时一个可以对数组进行操作的工具类，该类中提供了获取最值、排序的功能。
@author 张三
@version v1.1

*/
public class ArrayTool
{
/**
空参数构造函数。
*/
private ArrayTool(){};
/**
获取一个整形数组中的最大值。
@param arr 接收一个int类型的数组。
@return 会返回一个该数组中的最大值。
*/
public static int getMax(int [] arr)
{
int max = 0;
for (int x=0; x<arr.length ; x++ )
{
if (arr[x] > arr[max])
{
max = x;
}
}
return arr[max];
}
/**
获取一个整形数组中的最小值。
@param arr 接收一个int类型的数组。
@return 会返回一个该数组中的最小值。
*/
public static int getMin(int [] arr)
{
int min = 0;
for (int x = 0; x<arr.length ; x++ )
{
if (arr[x] < arr[min])
{
min = x;
}
}
return arr[min];
}
/**
选择排序。
@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类型的数组。
*/
public static void bubbleSort(int [] arr)
{
for (int x = 0; x<arr.length-1 ; x++ )
{
for (int y = 0; y<arr.length - x - 1 ; y++ )
{
if (arr[y]>arr[y+1])
{
swap(arr,y,y+1);
}
}
}
}
/**
给数组中的元素进行位置的置换。
@param arr 接收一个int类型的数组。
@param a 要置换的位置。
@param b 要置换的位置。
*/
private static void swap(int [] arr, int x, int y)
{
int temp = arr[x];
arr[x] = arr[y];
arr[y] = temp;
}
/**
用于打印数组中的元素。
*/
public static void printArray(int [] arr)
{
for (int x = 0; x<arr.length ; x++ )
{
System.out.print(arr[x]+",");
}
System.out.println();
}
}

用javadoc命令来生成文档



生成的文档时html格式的，进入index.html查看



注意，类的访问权限必须是public的，所以java源文件名必须与类名一致

文档中显示的内容是对外公开的，只有public和protected权限的内容才会被显示。

一个类中默认会有一个空参数的构造函数，这个默认构造函数的权限和所属类一致。

如果类被public 修饰，那么默认构造函数也带public 修饰符。

如果类没有被public修饰，那么默认的构造函数也没有被public修饰。

API文档



---------------------- ASP.Net+Unity开发、.Net培训、期待与您交流！ ----------------------