java doc文档标记的说明

javadoc

1. 概要描述
2. 详细描述
3. 文档标注 ：注释中@开头注解 称为Javadoc的文档标注

方法上的文档标注

1. @param <参数名> <参数描述>
2. @return <返回值得描述>
3. @throws <异常类型> <异常描述> 用于描述方法内部可能抛出的异常
4. @exception <异常类型> <异常描述> 用于描述方法签名对应的异常
5. @see 描述可以参考的类或者方法
6. @value 格式{@value } 用于表示常量的值
7. @inheritDoc 用于注解在重写方法或子类上，用于继承重写方法或者父类的javadoc

类上的文档标注

1. @author 标注作者 多个作者使用多个@author
2. @version 标注当前版本
3. @since 从这个版本开始 版本号或者日期
4. @see 描述可以参考的类或者方法
5. @param 如果有泛型 使用该标注说明
6. @inheritDoc 用于注解在重写方法或子类上，用于继承重写方法或者父类的javadoc

所有文档标记的描述中都可以使用 {@link } {@code }标注注释中出现的类 方法 代码段

使用命令生成javadoc

javadoc -d <文件存储目录>  -head <文件头部名称> -version <显示版本> 
-author <显示作者>  [软件包名称] [源文件] [@file]