day08Java-如何制作工具类的说明书(API)

如何制作工具类的说明书(API)

有的时候我们自己会写一个工具类,需要给别人使用,这个时候就需要制作一个该工具类的帮助文档,也就是该工具类的API。
帮助文档命令
DOS命令
提取作者：-author
提取版本：-version
javadoc -d doc的输出目录 -author -version 需要制作帮助文档工具类的路径
举例
javadoc -d D:\doc -author -version D:\eOMP\myworkspace\JavaTest\src\com\tellhow\test\jwh\bzword\ArrayTool.java

首先写一个对数组操作的工具类

package com.tellhow.test.jwh.bzword;

/**
 * 这是一个操作数组的工具类
 * 
 * @author 姜文豪
 * @date 2020年3月6日
 * @version V1.0
 */
public class ArrayTool {
	// 将构造私有化,就不能创建对象了。
	private ArrayTool() {
	};

	/**
	 * 这是一个遍历数组的方法
	 * @param int[]  arr 需要遍历的数组
	 * @return 无返回值
	 */
	public static void printArray(int[] arr) {
		System.out.println("[");
		for (int x = 0; x < arr.length; x++) {
			if (x == arr.length - 1) {
				System.out.println("]");
			} else {
				System.out.println(arr[x]);
			}
		}
	}

	/**
	 * 这是一个获取数组最大值的方法
	 * @param int[] arr 这是需要获取最大值的数组
	 * @return 遍历后返回的最大值
	 */
	public static int getMax(int[] arr) {
		int max = arr[0];
		for (int x = 1; x < arr.length; x++) {
			if (max < arr[x]) {
				max = arr[x];
			}
		}
		return max;
	}
	
	/**
	 * 这是一个获取数组中指定数字的索引
	 * @param int[] arr 需要的是一个数组
	 * @param int number 需要的是一个数字
	 * @return int 返回值如果是-1证明不存在
	 */
	public static int getIndex(int[] arr, int number) {
		for (int x = 1; x < arr.length; x++) {
			if (arr[x] == number) {
				return x;
			}
		}
		return -1;
	}
}

开始制作帮助文档
出现报错：找不到可以文档化的公共或受保护的类：告诉我们类的权限。
原因:是因为ArrayTool工具类,访问权限不够,没有被public修饰,加上就可以了。

加上public修饰

出现警告：是因为在注释里面的数据类型可以去掉就不会出现了。

查看doc目录
javadoc -d D:\doc -author -version D:\eOMP\myworkspace\JavaTest\src\com\tellhow\test\jwh\bzword\ArrayTool.java
doc目录所在位置（也就是输出目录）：D:\doc

目录结构

打开index.html就可以查看数组工具类的帮助文档

帮助文档制作完成。

如何使用帮助文档java的api

1:打开帮助文档
2:点击显示，找到索引，看到输入框
3:知道你要找谁?以Scanner举例
4:在输入框里面输入Scanner，然后回车
5:看包
java.lang包下的类不需要导入，其他的全部需要导入。
要导入：
java.util.Scanner
6:再简单的看看类的解释和说明，别忘了看看该类的版本
7:看类的结构
成员变量 字段摘要
构造方法 构造方法摘要
成员方法 方法摘要
8:学习构造方法
A:有构造方法 就创建对象
B:没有构造方法 成员可能都是静态的
9:看成员方法
A:左边
是否静态：如果静态，可以通过类名调用
返回值类型：人家返回什么，你就用什么接收。
B:右边
看方法名：方法名称不要写错
参数列表：人家要什么，你就给什么；人家要几个，你就给几个