java帮助文档-制作，使用，猜数字游戏

帮助文档

1. 代码演示

• 找不到可以文档化的公共或受保护的类。
  给类加上public

/**
这是一个数组操作工具类，里面包含了很多对数组操作的方法
@author Tony
@version 1.0
*/
public class ArrayTools{
	//把构造方法私有，外部就不能创建对象了。
	private ArrayTools(){}
	/**
	这是一个遍历数组的方法，遍历后的格式：[元素，元素，...]
	@param arr:要遍历的数组
	*/
	public static void printArray(int[] arr){
		System.out.print("[");
		for(int i=0;i<arr.length;i++){
			if(i==arr.length-1){
				System.out.println(arr[i]+"]");
			}else{
				System.out.print(arr[i]+",");
			}
		}
	}
	/**
	这是一个获取数组中最大值的方法
	@return int 返回数组中的最大值
	@param arr:要获取最大值的数组
	*/
	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;
	}
	/**
	这是一个获取数组中最小值的方法
	@return int 返回数组中的最小值
	@param arr:要获取最小值的数组
	*/
	public static int getMin(int[] arr){
		int min = arr[0];
		for(int i=1;i<arr.length;i++){
			if(arr[i]<min){
				min = arr[i];
			}
		}
		return min;
	}
	/**
	这是一个数组元素逆序的方法
	@param arr:要逆序的数组
	*/
	public static void reverse(int[] arr){
		/*
		for(int i=0;i<arr.length/2;i++){
			int temp = arr[i];
			arr[i] = arr[arr.length-1-i];
			arr[arr.length-1-i] = temp;
		}
		*/
		
		for(int start=0,end=arr.length-1;start<end;start++,end--){
			int temp = arr[start];
			arr[start] = arr[end];
			arr[end] = temp;
		}
	}
	/**
	这是一个获取指定元素第一次在数组中出现的索引
	@return int 返回索引  -1 表示没有找到
	@param arr:要获取索引的数组
	@param value:要在数组中查找的值
	*/
	public static int getIndex(int[] arr,int value){
		int index = -1;
		for(int i=0;i<arr.length-1;i++){
			if(arr[i] == value){
				index = i;
				break;
			}
		}
		return index;
	}
}

class Test2{
	public static void main(String[] args){
		int[] arr = {1,2,3,4,5};
		//遍历数组
		ArrayTools.printArray(arr);
		//获取最大值
		int max = ArrayTools.getMax(arr);
		System.out.println("最大值是"+max);
		//获取最小值
		int min = ArrayTools.getMin(arr);
		System.out.println("最小值是"+min);
		//数组元素逆序
		ArrayTools.reverse(arr);
		ArrayTools.printArray(arr);
		//获取指定元素索引
		int index = ArrayTools.getIndex(arr,5);
		System.out.println("索引值是"+index);
	}
}

2. 如何制作一个帮助文档？

• 写一个类
• 给类添加文档注释
  　　给哪里加？
  　　　　给类加，给类中所有成员加。
  　　加什么东西？
  　　　　类是干啥的。类中的成员变量都是什么，类中的成员方法都是干什么的
  　　　　方法的参数是什么 返回值返回的是什么
• 使用javadoc命令

javadoc -d 路径 -author -version 文件名.java

• java已经给我们提供了很多类，每个类中都有很多已经写好的方法供我们以后使用,如何学习这些东西呢？不用担心，java同样针对它提供的东西也给我们准备了一份说明书

3. 如何使用帮助文档呢？

• 打开帮助文档，点击显示，点击索引，出现输入框
• 在输入框中输入你要学习的类的类名，然后回车
• 先看包，java.lang包以外的类，用的时候都需要导包
  比如前边的import java.util.Scanner;
• 简单的看一下类的说明，主要看版本
• 看类的结构
  　　成员变量：字段摘要
  　　构造方法：构造方法摘要
  　　成员方法：方法摘要
• 先看构造方法
  　　有没有构造方法
  　　　　有，我们将来可以创建对象，里面也可以包含一些静态方法
  　　　　没有，要么类的成员都是静态的。要么里面肯定会有一个静态的方法可以获取该类的对象
• 看成员变量
  　　先看左：看修饰符是否静态，看数据类型
  　　后看右：看变量名
• 看成员方法：
  　　先看左：
  　　　　看是否静态。
  　　　　看返回值类型 人家反什么，将来就用什么接收
  　　在看右：
  　　　　看方法名
  　　　　看参数列表：人家要什么你给什么，人家要几个你给几个

4.猜数字游戏

import java.util.Scanner;
class Demo{
	public static void main(String[] args){		
		//生成1-100的随机数
		int answer = (int)(Math.random()*100)+1; 
		System.out.println(answer);
		
		int min = 1;
		int max = 100;
		while(true){
			// 键盘录入数据
			Scanner sc = new Scanner(System.in);
			System.out.println("请输入你要猜的数据：(" + min + "~" + max + ")");
			
			int guessNum = sc.nextInt();
			if(guessNum > 100 || guessNum < 1){
				System.out.println("输入数据无效");
			}
			
			if(guessNum > answer){
				max = guessNum;
                System.out.println("你猜大了");
			}else if(guessNum < answer){
				min = guessNum;
				System.out.println("你猜小了");
			}else{
				System.out.println("你猜对了");
				break;
			}
		}
	}
}