在java中制作帮助文档

1. 制作帮助文档

1.1 制作工具类

​ •ArrayTools

1.2制作帮助文档(API)

​ •javadoc -d 目录 -author -version ArrayTool.java

/**
* 这是针对数组进行操作的工具类
* @author
* @version V.10
*/
public class ArrayTool {
	
	//把构造方法私有，外界就不能在创建对象了
	/**
	* 这是私有构造
	*/
	private ArrayTool(){}

	/**
	* 这是遍历数组的方法，遍历后的格式是：[元素1, 元素2, 元素3, ...]
	* @param arr 这是要被遍历的数组
	*/
	public static void printArray(int[] arr) {
		System.out.print("[");
		for(int x=0; x<arr.length; x++) {
			if(x == arr.length-1) {
				System.out.println(arr[x]+"]");
			}else {
				System.out.print(arr[x]+", ");
			}
		}
	}
	
	/**
	* 这是获取数组中最大值的方法
	* @param  arr 这是要获取最大值的数组
	* @return 返回数组中的最大值
	*/
	public static int getMax(int[] arr) {
		int max = arr[0];
		
		for(int x=1; x<arr.length; x++) {
			if(arr[x] > max) {
				max = arr[x];
			}
		}
		
		return max;
	}
	
	/**
	* 获取指定元素在数组中第一次出现的索引，如果元素不存在，就返回-1
	* @param arr 被查找的数组 
	* @param value 要查找的元素
	* @return 返回元素在数组中的索引，如果不存在，返回-1
	*/
	public static int getIndex(int[] arr,int value) {
		int index = -1;
		
		for(int x=0; x<arr.length; x++) {
			if(arr[x] == value) {
				index = x;
				break;
			}
		}
		
		return index;
	}
}

2 如何使用帮助文档

找到文档，打开文档

点击显示，找到索引，出现输入框

你应该知道你找谁?举例：Scanner

看这个类的结构(需不需要导包)

​ •成员变量 字段

​ •构造方法 构造方法

​ •成员方法 方法

看这个类的说

看构造方法

看成员方法

然后使用

3 Math类

Math类概述

​ •Math包含用于执行基本数学运算的方法

Math类特点

​ •没有构造方法，因为成员都是静态的

获取1-100之间的随机数

/*
	Math:类包含用于执行基本数学运算的方法
	
	由于Math类在java.lang包下，所以不需要导包。
	特点：
		没有构造方法，因为它的成员全部是静态的。
		
	掌握一个方法：
		获取随机数
		public static double random():返回带正号的 double 值，该值大于等于 0.0 且小于 1.0。
*/
class MathDemo {
	public static void main(String[] args) {
		//获取一个随机数
		//double d = Math.random();
		//System.out.println(d);
		
		//需求：我要获取一个1-100之间的随机数，肿么办?
		for(int x=0; x<100; x++) {
			int number = (int)(Math.random()*100)+1;
			System.out.println(number);
		}
	}
}

4 案例

​ •猜数字小游戏

/*
	猜数字小游戏(数据在1-100之间)
	
	分析：
		A:程序产生一个随机数。(被猜的)
		B:键盘录入数据。(你猜的)
		C:把你猜的和被猜的进行比较
			a:大了
			b:小了
			c:猜中了
		D:给出多次猜的机会，猜中就结束。
			while()循环，猜中就break
*/
import java.util.Scanner;

class GuessNumber {
	public static void main(String[] args) {
		//程序产生一个随机数。(被猜的)
		int number = (int)(Math.random()*100)+1;
		//System.out.println(number);
		
		//给出多次猜的机会，猜中就结束。
		while(true) {
			//键盘录入数据。(你猜的)
			Scanner sc = new Scanner(System.in);
			System.out.println("请输入你要猜的数据(1-100):");
			int guessNumber = sc.nextInt();
			
			//把你猜的和被猜的进行比较
			if(guessNumber > number) {
				System.out.println("你猜的数据"+guessNumber+"大了");
			}else if(guessNumber < number) {
				System.out.println("你猜的数据"+guessNumber+"小了");
			}else {
				System.out.println("恭喜你，猜中了");
				break;
			}
		}
	}
}

uessNumber+“大了”);
}else if(guessNumber < number) {
System.out.println(“你猜的数据”+guessNumber+“小了”);
}else {
System.out.println(“恭喜你，猜中了”);
break;
}
}
}
}