JavaDoc生成API文档（powernode document）（内含源代码和导出的文档）

源代码和导出的文档下载链接地址：https://download.csdn.net/download/weixin_46411355/87473296

1.1 JavaDoc概述

JavaDoc是Java自带的一种工具，其可以从程序源代码中抽取类、方法、属性等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。
  
Java中有三种注释方法：//单行注释、/多行注释/和/文档注释/，其中第三种专为JavaDoc设计，可以被JDK内置的JavaDoc工具支持和处理。我们可以通过Eclipse来实现Java文件的API文档生成。

1.2 文档注释的格式

Javadoc生成的文档是HTML格式，而这些HTML格式的标识符并不是javadoc添加的，而是我们在写注释的时候写上去的。使用文档注释时，我们应该合理的使用块标记来添加注释信息，常用的块标记包括：

• @author 标明开发该类模块的作者

• @version 标明该类模块的版本

• @param 对方法中某参数的说明

• @return 对方法返回值的说明

• @exception 对方法可能抛出的异常进行说明

【示例】使用块标记实现文档注释案例

/**
 * Student类
 * @author HHH
 * @version 1.0.0
 */
public class Student {
    /**
     * 学生名字
     */
    private String name;
    /**
     * 学生年龄
     */
    private int age;
    /**
     * 无参构造方法
     */
    public Student() {
    }

    /**
     * 有参构造方法
     * @param name 学生姓名
     * @param age 学生年龄
     */
    public Student(String name, int age) {
        this.name = name;
       setAge(age);
    }

    /**
     * name属性的get方法
     * @return 返回学生的姓名
     */
    public String getName() {
        return name;
    }

    /**
     * name属性的set方法
     * @param name 需要赋值的姓名
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * age属性的get方法
     * @return 返回学生的年龄
     */
    public int getAge() {
        return age;
    }

    /**
     * age属性的set方法
     * @param age 需要赋值的年龄
     */
    public void setAge(int age) {
        //在赋值之前先判断年龄是否合法
        if(age>130||age<0){
            this.age = 0;//不合法赋默认值0
        }else{
            this.age = age;
        }

    }

    /**
     * 输出学生信息
     */
    void show(){
        System.out.println("name: "+name+"age: "+age);
    }
}

1.3 IDEA生成API文档

IDEA 的 JavaDoc 生成功能在菜单 Tools->Generate JavaDoc 项里面。


生成的文档