如何生成自己的API - 黑马程序员技术交流社区

在DOS下使用 //javadoc -d myhelp -author -version ArrayTool.java
ArrayTool.java 是表明要把哪个java文件生成文档，一般都是工具类才要生成文档，工具类的方法上都要加上文档注释才能生成。
比如
/**
这是一个可以对数组进行操作的工具类，该类中提供了，获取最值，排序等功能。
@author JiangShanShan
@version V1.0
*/
public class ArrayTool {
/**
空参数构造函数。
*/
private ArrayTool(){};//防止别人new对象
/**
获取一个整形数组中的最大值。
@param arr 接收一个int类型的数组。
@return 会返回一个该数组中最大值。
*/
//获取最大值
public static int getMax(int arr []){//一定要加上static，对方通过类名调用该方法，在创建对象之前，所以必须得定义成静态的
int maxIndex = 0;//定义变量，记录最大值的角标
for(int x=0;x<arr.length;x++){//要想挨个比值，必须先循环遍历拿出数组里的值，所以先遍历后比较
if(arr[x]>arr[maxIndex])
maxIndex = x;
}
return arr[maxIndex];
}
/**
获取一个整形数组中的最小值。
@param arr 接收一个int类型的数组。
@return 会返回一个该数组中最小值。
*/
//获取最小值
public static int getMin(int arr[]){
int minIndex = 0;
for(int x=0;x<arr.length;x++){
if(arr[x]<arr[minIndex])
minIndex = x;
}
return arr[minIndex];
}
/**
给int数组进行选择排序。
@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])
changePosition(arr,x,y);
}
}
}

复制代码

/*
文档注释
*/
/**
此类是对数组进行取最值排序等操作的
@author 张三
@version 1.0
*/
public class ArrayOperate{
private ArrayOperate(){}//将构造函数私有化，否则提取中会默认有构造器和说明
/**
取int数组里面的最大值
@param arr 传入一个int数组
@return 返回一个int数值
*/
public static int max(int[] arr){
int max=arr[0];
for(int i=0;i<arr.length;i++){
if(arr[i]>max){
max=arr[i];
}
}
return max;
}
/**
取int数组里面的最小值
@param arr 传入一个int数组
@return 返回一个int数值
*/
public static int min(int[] arr){
int min=arr[0];
for(int i=0;i<arr.length;i++){
if(arr[i<min]){
min=arr[i];
}
}
return min;
}
/**
对传入的int数组里面进行冒泡排序
@param arr 传入一个int数组
*/
public static void maoSort(int[] arr){//冒泡排序
for(int i=0;i<arr.length-1;i++){
for(int j=0;i<arr.length-1;i++){
replace(arr,j,j+1);
}
}
}
/**
对传入的int数组里面进行选择排序
@param arr 传入一个int数组
*/
public static void xuanzeSort(int[] arr){//选择排序
for(int i=0;i<arr.length-1;i++){
for(int j=i+1;j<arr.length;j++){
replace(arr,i,j);
}
}
}
//私有化方法无需注释，也无法注释
private static void replace(int[] arr,int a,int b){
if(arr[a]>arr[b]){
int t=arr[a];
arr[a]=arr[b];
arr[b]=t;
}
}
}
/*
以上完成后在命令中进提取
如E：\java 目录下 //创建目录，作者，版本
E:\java>javadoc -d这个是dir的缩写意思是创建
Mydoc这个是创建文件夹 -author这个是作者
-version这个是版本 ArrayOperate.java最后跟上你的java文件名.java
E:\java>javadoc -d Mydoc -author -version ArrayOperata.java
*/
//提取成功后打开 index.html查看

复制代码