数组工具类
ArrayDemo.java和ArrayTool.java放于同一个文件夹下。
//ArrayDemo.java
/*
想要对数组进行操作
如何制作一个说明书?
A:写一个工具类
B;对这个类加入文档注释,如:
/**
*这是个什么方法
*@param 参数1 解释参数
*@param 参数2 解释..
*return 解释
*/
/* C: 用工具解析文档注释
javadoc工具
D: 格式
javadoc -d 目录 -author -version ArrayTool.java
目录:为输出目录。如命名为doc,且为当前路径下。没有的话,会自己创建
帮助文档报错1:找不到可以文档化的公共或受保护的类:告诉我们类的权限不够
解决:加个public: public class ArrayTool{}
报错2:java.lang.IllegalArgumentException
解决:把classpath相对路径设置成绝对路径,不出现%JAVA_HOME%
*/
//测试类
class ArrayDemo{
public static void main(String[] args){
int[] arr={22,33,44,55,66};
ArrayTool.printArray1(arr);
int max=ArrayTool.getMax(arr);
System.out.println("max is "+max);
int index=ArrayTool.getIndex(arr, 33);
System.out.println("Value is number"+(index+1));
}
}
//ArrayTool.java 写数组工具类ArrayTool,加了文档注释
/**
*这是针对数组进行操作的工具类
*@author 元气满满晨
*@version V1.0
*/
public class ArrayTool{
/**
*这是私有构造
*/
private ArrayTool(){}
/**
*这是遍历数组的方法。遍历后的格式是:元素1-元素2-元素3...
*@param arr 这是要被遍历的数组
*/
public static void printArray1(int[] arr){
for(int i=0; i<arr.length; ++i){
if(i==arr.length-1){
System.out.println(arr[i]);
}
else
System.out.print(arr[i]+"-");
}
}
/**
*这是获取数组中最大元素的方法。
*@param arr 这是要获取最大值得数组
*@return 返回数组中的最大值
*/
public static int getMax(int[] arr){
int max= arr[0];
for(int i=1; i<arr.length; ++i){
if(arr[i]>max){
max=arr[i];
}
}
return max;
}
/**
*获取指定元素在数组中第一次出现的方法。若数组中不存在该元素,返回-1
*@param arr 被搜索的数组
*@param value 要找的元素
*@return 返回元素在数组中的索引。若数组中不存在该元素,返回-1
*/
public static int getIndex(int[] arr, int value){
int index=-1;
for(int i=0; i<arr.length; ++i){
if(arr[i]==value){
index=i;
break;
}
}
return index;
}
}
用javadoc工具解析文档注释
格式:javadoc -d 目录 -author -version ArrayTool.java
目录表示输出目录。如命名为doc,且为当前路径下。没有的话,会自己创建
使用文档说明书
人家只提供给你class文件(ArrayTool.class),不给你源码。
那么怎么用?
我们可以:
根据说明书里index.html文件使用ArrayTool工具类。
使用jdk帮助文档
1:看包
java.lang包下的类不需要导入,其他的全部需要导入。
如,Scanner类要导入:java.util.Scanner
Math类在java.lang包下不需要导
2:再简单的看看类的解释和说明,别忘了看看该类的版本
3:看类的结构
成员变量 字段摘要
构造方法 构造方法摘要
成员方法 方法摘要
4:学习构造方法
A:有构造方法 就创建对象
B:没有构造方法 成员可能都是静态的
5:看成员方法
A:左边
是否静态:如果静态,可以通过类名调用
返回值类型:人家返回什么,你就用什么接收。
B:右边
看方法名:方法名称不要写错
参数列表:人家要什么,你就给什么;人家要几个,你就给几个