java说明书通过注释来完成。下面通过一个例子来看看如何制作JAVA程序的说明书,也就是大家经常听到的API。
温馨小贴士:解决DOS下中文编码问题 GBK
http://jingyan.baidu.com/article/ca2d939dc76c89eb6c31ce96.html
/**
这是一个可以对数组进行操作的工具类,该类中提供了,获取最值,排序等功能。
@author Jungle
@version V1.1
*/
public class ArrayDemo
{
/**
空参数构造函数。
*/
private ArrayDemo(){};
/**
获取一个整型数组中的最大值
@param arr 接收一个int类型的数组
@return 会返回一个该数组中最大值
*/
public static int getMax(int[] arr)
{
int max = 0;
for(int i = 1;i<arr.length;i++)
{
if(arr[i]>arr[max])
{
max = i;
}
}
return arr[max];
}
/**
获取一个整型数组中的最小值
@param arr 接收一个int类型的数组
@return 会返回一个该数组中最小值
*/
public static int getMin(int[] arr)
{
int min = 0;
for(int i = 1;i<arr.length;i++)
{
if(arr[i]<arr[min])
{
min = i;
}
}
return arr[min];
}
/**
给int数组进行选择排序。
@param arr 接收一个int类型的数组
*/
public static void selectSort(int[] arr)
{
for(int i = 0;i<arr.length-1;i++)
for(int j =i+1;j<arr.length;j++ )
{
if(arr[i]>arr[j])
{
swap(arr,i,j);
}
}
}
/**
给int数组进行冒泡排序。
@param arr 接收一个int类型的数组
*/
public static void bubbleSort(int []arr)
{
for(int i = 0;i<arr.length-1;i++)
for(int j =0;j<arr.length-i-1;j++)
{
if(arr[j]>arr[j+1])
{
swap(arr,j,j+1);
}
}
}
/**
给数组中元素进行位置的置换
@param arr 接收一个int类型的数组
@param a 要置换的位置
@param b 要置换的位置
*/
private static void swap(int[] arr,int a,int b )
{
int temp = arr[a];
arr[a] = arr[b];
arr[b] = temp;
}
/**
用于打印数组中的元素。打印形式是[element1,element2,element3,.....]
@param arr 接收一个int类型的数组
*/
public static void prinT(int[] arr)
{
System.out.print("[");
for(int k = 0;k<arr.length;k++)
{
if(k!=arr.length-1)
System.out.print(arr[k]+",");
else
System.out.print(arr[k]+"]");
}
}
}
DOS下运行:javadoc -d myhelp -author -version ArrayDemo.java
对应的目录下如果没有myhelp的文件夹,会自动创建如下:
点击打开以后:
赶紧试试吧。