1. 程式人生 > >Java中如何製作一個文件說明書

Java中如何製作一個文件說明書

陣列工具類:陣列工具類裡面提供針對陣列進行的操作。例如:遍歷陣列

public class ArrayTool {
將無參構造私有化,目的是為了讓外界不能訪問
    private ArrayTool() {

    }

    直接定義成員方法.printArray()遍歷陣列
    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]+, ); } } } }

如何製作一個文件說明書

1)建立一個數組,靜態初始化
2)建立一個工具類,ArrayTool,提供一些靜態功能:遍歷,最大值,索引
3)ArrayTool,每類、方法前加上文件註釋
4)開啟dos控制檯:找到當前路徑,輸入 javadoc -d 目錄名 -author -version ArrayTool.java

ArrayDemo類

import java.util.Scanner;

/**
  需求自定義一個數組,遍歷陣列
  製作文件說明書
       可以定義一個ArrayTool,陣列操作的工具類
       在工具類,必須文件註釋,來讓解析成文件
       在陣列工具類ArrayTool,提供遍歷功能,獲取最大值的,查詢陣列中某個元素第一次出現的索引
  @author Administrator
 */

public class ArrayDemo {
    public static void main(String[] args) {
        Scanner sc = new
Scanner(System.in); int[] arr = {10,20,30,40,50}; System.out.print(陣列遍歷為:); ArrayTest.printArray(arr); int max = ArrayTest.getMax(arr); System.out.println(最大值為:+max); System.out.print(請輸入您要查詢的數:); int value = sc.nextInt(); int index = ArrayTest.getIndex(arr,value); System.out.println(索引為:+index); } }

ArrayTool類

/**
  當前這個ArrayTool這個類是針對陣列操作的工具類,裡面提供了遍歷陣列以及獲取陣列的最大值和
  查詢陣列中第一次出現的索引這些功能
  @author 王子泉
  @version V1.0
 */
public class ArrayTest {
    private ArrayTest() {

    }

/**     當前這個方法是針對陣列遍歷的功能
        @param arr 需要遍歷的陣列
*/     
    public static void printArray(int[] arr) {
        System.out.print([);
        for(int i=0;iarr.length;i++)
        {
            if(i==arr.length-1)
            {
                System.out.println(arr[i]+]);
            }else
            {
                System.out.print(arr[i]+,);
            }
        }
    }

/**   當前這個方法是針對陣列求最大值的功能
      @param arr 需要遍歷的陣列
      @return 返回陣列最大值
*/
    public static int getMax(int[] arr) {
        int max = arr[0];
        for(int i=1;iarr.length;i++)
        {
            if(arr[i]max)
            {
                max = arr[i];
            }
        }
        return max;
    }

      當前這個方法是針對陣列求索引的功能
      @param arr 
      @param value 
      @return 

    public static int getIndex(int[] arr,int value) {
        int index = -1 ;
        for(int i=0;iarr.length;i++)
        {
            if(arr[i]==value)
            {
                index = i ;
                break;
            }
        }
        return index;
    }
}

如何使用文件說明書
進入jdk文件之後,點選顯示—索引—-查詢哪個類,例如:Scanner,然後找到官方提供的類。
需要觀察
1)該類中有沒有欄位
2)該類中有沒有構造方法
3)該類中有沒有成員方法
4)jdk的版本號