javadoc

JavaDoc

是用来生成自己的API文档的，和文档注释相关。

即：

 /**
  * @author guan
  * @version 1.0
  * @since 1.8
  * @param name
  * @return
  * @throws Exception
  */

 

author 作者名

version 版本

since 知名需要最早使用的jdk版本

param 参数 名

return 返回值情况

throws 异常抛出情况

加在类的上面就是类的注释，加在方法上面就是方法 的注释。

 

把DOC编译成文档，方便阅读。（生成javadoc文档）