JavaSE学习（1）：如何制作帮助文档

一、自己制作帮助文档（工具类）：

构造方法私有化：

      成员方法静态化 只能通过类名调用，不能创建新对象

Javadoc：文档工具：

    格式：javadoc -d 目录 -author -version 文件名.java

    文档工具只解析public 和protected修饰的

二、如何查看帮助文档？：

举例：Math类

1. 关注包

java.lang 不需要导包

如果不是这个包，就需要导包

2. 关注类的定义, 关注继承关系等信息

public final class Math extends Object

3. 类的概述：

Math 类包含用于执行基本数学运算的方法，如初等指数、对数、平方根和三角函数。

4. 版本, 可以知道jdk的发展历史, 如果版本比使用的jdk版本高，就不能使用。

JDK1.0

5. 构造方法

就知道如何根据图纸创建对象

6. 查看要查找方法：

static double random() [0.0, 1.0)

        返回带正号的 double 值，该值大于等于 0.0 且小于 1.0。

三、练习

题目： 写一个数组的工具类ArrayTool, 要求提供遍历，求最大值，最小值，逆序，查表，找元素在数组中最后出现的索引等操作。并生成帮助文档

[code]/**
2这是我写的一个整形数组的工具类ArrayTool, 提供遍历，求最大值，最小值，逆序，查表，找元素在数组中最后出现的索引等操作。
3  @author 潇雷
4  @version 2019年5月15日
5*/
6
7public class ArrayTool{
8  /**
9  将构造方法私有化，防止外界创建对象
10  */
11  private ArrayTool(){
12
13  }
14  /**
15  遍历数组
16  @param arr传入一个一维整形数组
17  */
18  public static void traversal(int arr[]){
19    //遍历数组
20    for(int i=0;i<arr.length;i++)
21    {
22      if(i<arr.length-1)
23      {
24        //输出遍历结果
25        System.out.println("{"+arr[i]+" ");
26      }
27      else{
28        //如果是最后一位，则输出右括号
29      System.out.println(arr[i]+"}");
30      }
31    }
32  }
33  /**
34  @param arr 求一维数组的max
35  */
36  public static int max(int arr[]){
37    int max=arr[0];
38    for(int i=1;i<arr.length;i++)
39    {
40      if(arr[i]>max){
41        max=arr[i];
42      }
43    }
44    return max;
45  }
46  /**
47  @param arr 求一维数组的min
48  */
49  public static int min(int arr[]){
50    int min=arr[0];
51    for(int i=1;i<arr.length;i++){
52      if(arr[i]<min){
53        min=arr[i];
54      }
55    }
56    return min;
57  }
58  /**
59  @param arr 将一维数组逆序
60  */
61  public static void reverse(int arr[]){
62    for(int i=0;i<arr.length/2;i++){
63      int temp;
64       temp=arr[i];
65       arr[i]=arr[arr.length-i-1];
66       arr[arr.length-i-1]=temp;
67    }
68  }
69  /**查表，找元素在数组中最后出现的索引等操作。
70  @param arr 输入一个一维数组
71  @param key 需要查找的元素
72  */
73  public static int find(int arr[],int key){
74    int index=-1;//定义一个数组下标
75    for(int i=0;i<arr.length;i++){
76     if(arr[i]==key){
77         index=i;
78     }
79       }
80    return index;
81  }
82}

在生成代码块的时候，遇到了下面的这个错误：

java.lang.IllegalArgumentException

解决方法：

经过后面解决：是classpath环境变量的配置出错问题，classpath目录下的.class文件可以在任意目录运行，配置好后，目录下的.class在任何位置都能打开，但是不推荐配置，因为会优先取class搜索。本题遇到的问题出错也是和classpath环境变量的配置出错相关的，因此，采用的解决措施是把删除classpath路径。

最终生成了API帮助文档。

关注微信公众号：潇雷

一起学习，共同进步！