JAVA如何在eclipose中生成帮助文档

Posted 2020-10-31 jiangximing

JAVA中注释有三种   1 单行注释 //+内容      2 多行注释  /* 内容 */  3 文档注释  /**内容*/

      其中单行注释和多行注释是用于方法里面的注释 ，文档注释是用来注释类的成员和方法。

  帮助文件是用多行注释实现的，用的程序是JAVA中jdk目录下bin目录JAVAdoc.exe。

首先 打开eclipose,找到一个需要生成帮助文档的工程。工程里面的类都是用多行注释标记了方法和属性的。比如

package java4_10;
/**
 * 
 * @author 我
 *
 */
public class DEpt {
private int age;
public String name;
public String master;
/**
 * 修改器，可以完成私有属性的修改
 * @param age 年龄
 */
public void setAge(int age){
    this.age = age;
}
/**
 * 访问器，可以得到私有属性的值
 * @return  年龄
 */
public int getAge(){
    return this.age;
}
public void setName(String name){
    this.name = name;
}
public String getName(){
return this.name;
}
}

然后在工程上点击右键找到 Export选项，在如下对话框依次选择 java—————javadoc

 

 双击javadoc跳转如下对话框

在Destination下选择要生成的帮助文件保存位置

选择Java中javadoc.exe程序路径 单击finish就自动生成帮助文件

然后在你保存帮助文件的地方就有了如下文件

然后点击index.html选择你想要查看的包的类，就可以查看帮助文档了