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路径下的binjavadoc.exe

Select types fro whick javadoc will be generated:选择要生成帮助文档的类

Destination：生成帮助文档的路径

点击finish

4.到帮助文档路径下找到index.html打开

5.打开后的首页

6.点击ArraryTool，就能查看到这个类中的方法及用法