Java doc的基本使用

一：基本概念

Javadoc是用于描述类或者方法的作用。
Javadoc可以写在类上面和方法上面。

二：基本注释

//用于注释一行
/* … * / 注释若干行
/** …* /用于注释javadoc

三：基本使用

1. 第一部分：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束（以此来区分概要和后面的部分）

 /**
 *使用方法的简述.
 *
 */

2. 第二部分：详细描述，通常用一段或者多段话来详细描述该类的作用，以英文句号作为结束

 /**
 * 使用方法的简述.
 * <p>
 * 方法描述
 * 方法描述
 * </p>
 * 
 */

3. 第三部分：文档标注，用于标注作者、创建时间、参阅类等信息

/**
 * 使用方法的简述.
 * <p>
 * 方法描述
 * 方法描述
 * </p>
 * @author HP
 * @version 1.2
 */

举例：

/**
 * 简单描述.                                         
 * 详细描述.                             
 * ...
 * ...
 * @author 描述文本                   
 * @return  描述文本
 */
public int methodName (...) {
    // method body with a return statement
}

四：打开方式

1. 右键打开到处导出按钮
2. 打开javadoc文件
   
3. 选择javadoc文件要防止放置的位置
4. 根据需要配置Javadoc的自变量，可以通过”基本选项“下的复选框来选择Javadoc选项。
   如果想引用一个库中的类，并且将该库链接到它的javadoc，可以在“Select referenced archives and projects to which links should be generated:”列表中选择，然后点击next按钮。
   
5. 因为java项目是采用的UTF-8编码，所以我们要在extra javadoc…中添加-encoding UTF-8 -charset UTF-8来保证不乱码
   
6. 打开该项目下的doc文件
   
   找到index文件
   
   展示javadoc