6.JAVA基礎複習——JAVA中文檔註釋與幫助文檔的生成

java中的文檔註釋：用於說明該類的功能做用方便他人使用
關鍵詞前須要加@符
　　用於類的註釋
　　　　@author name 做者
　　　　@version v1.0 版本

　　　　……
　　用於函數的註釋
　　　　@param parameter 參數
　　　　@return value 返回值

　　　　……

首先要給類加上幫助文檔註釋/** */用於類、函數的說明

 1 package com.jdbc.test;
 2 
 3 /**
 4  * 數組工具類,用於數組的一些經常使用方法
 5  * @author 張三
 6  * @version v1.0
 7  * */
 8 public class ArraryTool {
 9     
10     private ArraryTool(){
11         
12     }
13     
14     /**
15      * 獲取數組的長度
16      * @param arr 傳入一個int類型的數組
17      * @return    返回數組長度
18      */
19     public static int getLength(int[] arr){
20         return arr.length;
21     }
22     
23     /**
24      * 獲取數組中最大的值
25      * @param arr 傳入一個int類型的數組
26      * @return    返回最大值
27      */
28     public static int getMax(int[] arr){
29         int max = arr[0];
30         for (int i = 1; i < arr.length; i++) {
31             if(max<arr[i]){
32                 max = arr[i];
33             }
34         }
35         return max;
36     }
37     /**
38      * 數組降序排序函數
39      * @param arr 傳入一個int類型的數組
40      */
41     public static void arrarySort(int[] arr){
42         for (int i = 0; i < arr.length; i++) {
43             for (int j = 0; j < arr.length-1; j++) {
44                 compare(arr, i, j);
45             }
46         }
47     }
48     /**
49      * 查看數組中的元素
50      * @param arr 傳入一個int類型的數組
51      * @return    返回數組中的全部元素
52      */
53     public static String selectArrary(int[] arr){
54         String str = "[";
55         for (int i = 0; i < arr.length; i++) {
56             str+=arr[i]+",";
57         }
58         return str+"]";
59     }
60     /**
61      * 根據數組下標查找元素
62      * @param arr 傳入一個int類型的數組
63      * @param num 數組下標
64      * @return    查找下標的值
65      */
66     public static int getIndex(int[] arr,int num){
67         int value = -1;
68         for (int i = 0; i < arr.length; i++) {
69             if (arr[i]==arr[num]) {
70                 return value = arr[i];
71             }
72         }
73         return value;
74     }
75     
76     /**
77      * 獲取數組的降序比較方法
78      * @param arr 傳入一個int類型的數組
79      */
80     private static void compare(int[] arr, int i, int j) {
81         if(arr[i]>arr[j]){
82             int temp = arr[i];
83             arr[i] = arr[j];
84             arr[j] = temp;
85         }
86     }
87 
88 }

在不想讓人家看見源碼而又能使用這個類的時候咱們須要對此類進行封裝並生成幫助文檔方便使用

當別人使用時只須要編譯好的.class文件和幫助文檔就可以使用其中的功能。

使用myeclipse生成幫助文檔：

1.在項目或類上右鍵選擇Export...

2.選擇java中的javadoc點擊next

 

3.Javadoc command：選擇已安裝jdk路徑下的bin\javadoc.exe

Select types fro whick javadoc will be generated:選擇要生成幫助文檔的類

Destination：生成幫助文檔的路徑

點擊finish

4.到幫助文檔路徑下找到index.html打開

5.打開後的首頁

6.點擊ArraryTool，就能查看到這個類中的方法及用法