需求: 针对数组操作的工具类
如何制作一个文档说明书?
(1)创建一个数组,静态初始化
(2)创建一个工具类,ArrayTool,提供一些静态功能
遍历,最值,查找
(3)ArrayTool,每类,方法加上文档注释
(4)在任意盘创建一个文件夹,在该文件夹内创建两个文本文件,并分别改名为ArrayTool.java和ArrayDemo.java,将除包以外的 其余内容分别复制到两个java文件中
(5)打开dos控制台:
找到当前路径: javadoc -d doc -author -version ArrayTool.java
(6)打开新生成的doc 文件,里面有一个index.html文件,打开即为一个简易的文档说明书
代码如下:
ArrayTool.java
package org.westos.制作文档说明书; /** * 这是针对数组操作的一个工具类,该工具类提供了一些数组的遍历,获取数组的最大值以及查找数组的元素的功能 * * @author Li * @version V1.0 */ public class ArrayTool { /** * 这是一个私有的无参构造,目的是为了不让外界创建对象 * */ private ArrayTool() {} /** * 这是数组遍历的方法 * @param arr 是一个int类型的数组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 需要在当前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) { for(int x=0;x<arr.length;x++) { if(arr[x]==value) { return x; } } return -1; } }
ArrayDemo.java
package org.westos.制作文档说明书; /** * 针对数组操作的工具类 */ public class ArrayDemo { public static void main(String[] args) { //创建一个数组,静态初始化 int[] arr = {53,89,27,10,30} ; //遍历 ArrayTool.printArray(arr); //求最大值 int max=ArrayTool.getMax(arr); System.out.println("max:"+max); //查找 int index=ArrayTool.getIndex(arr, 89); System.out.println("index:"+index); } }
效果展示如下: