如何编写javadoc文档注释

/** */为Javadoc文档注释标记，出现在声明（类的声明、变量的声明、方法的声明等）之前时，会被Javadoc文档工具读取为Javadoc文档内容。

/***这是一个示例*@author maixiaoyang*/public class Example() {}

上面的示例中，第一行用于描述注释的对象的主要功能，第二行@author是javadoc标签。
javadoc支持以下标签【只写几个常用的】：

标签 描述 示例 @author 标识写这个注释对象的作者 @author maixiaoyang @param 标识用到的参数以及参数的描述 @param param-name 这是一个参数 @return 标识返回值类型 @return 返回值的描述 @version 标识注释对象的版本 @version 版本号