文档相关注解

说明注释允许你在程序中嵌入关于程序的信息。你可以使用javadoc工具软件来生成信息，并输出到HTML文件中

说明注释，是你更加方便的记录你的程序信息。

文档注释我们一般使用在文档注释中，配合javadoc工具

javadoc工具软件识别一下标签

 

其中注意：

 

 

 IDEA中的javadoc使用

 

 

 防止乱码

 

 

 

 代码

package com.msb.anno;

/**
 * @author : liu
 * @version :1.0
 * 日期:14:24:37
 * 描述:IntelliJ IDEA
 * 版本:1.0
 */
public class Person {
    /**
     *下面是eat方法，实现了xxx功能
     * @param num1 就餐人数
     * @param num2 点了几个菜
     */
    public void eat(int num1,int num2){}

    /**
     *
     * @param age 年龄
     * @return int
     * @exception RuntimeException 当年龄过大的时候
     * @exception IndexOutOfBoundsException 当年龄过小的时候
     * @see Student
     */
    public int sleep(int age){
        new Student();
        if (age>100){
            throw new RuntimeException();
        }
        if (age<0){
            throw new IndexOutOfBoundsException();
        }
        return 10;
    }
}

public class Student {
}