java文档注释--javadoc的用法

1.前言

Java中有三种注释方式。前两种分别是 // 和 /* */，主要用于代码的注释，以此来方便代码的可读性。第三种被称作说明注释或文档注释，它以 /** 开始，以 */结束，文档注释允许你在程序中嵌入关于程序的信息，有了这个注释就可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。

2.文档注释的格式

/**
* .........
* .........
*/

在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。

之后，你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*)，其中常用的标签如下（详细标签请参考http://www.runoob.com/java/java-documentation.html）：

标签	描述	示例
@author	标识一个类的作者	@author description
@version	指定类的版本	@version info
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation

下面是一个类的说明注释的实例:

1 /** 我的数组帮助类
2 *定义一个用于操作数组的工具类。
3 *比如：获取最值，排序，折半。
4 *@author 张三
5 *@version V1.0
6 */
7 public class ArrayTool
8 {
9
10     /**
11     该类的空参数构造函数。
12     */
13     private ArrayTool(){}
14
15     /**
16     获取int数组的最大值。
17     @param arr 用于接收一个int类型的数组。
18     @return 返回该数组中的最大值。
19     */
20     public static int getMax(int[] arr)
21     {
22         int max = arr[0];
23         for(int x=1; x<arr.length; x++)
24         {
25             if(arr[x]>max)
26                 max = arr[x];
27         }
28
29         return max;
30     }
31     /**
32     对int数组进行从小打到的排序。
33     @param arr 用于接收一个int类型的数组。
34     */
35     public static void bubbleSort(int[] arr)
36     {
37     }
38 }

3. 使用javadoc生成文档

命令： javadoc -d 文档存放目录 -author -version 源文件名.java

这条命令编译一个名为"源文件名.java"的 java 源文件，并将生成的文档存放在"文档存放目录"指定的目录下，生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略

4.测试示例

4.1 操作命令





4.2 打开help文件夹下的index.html