JAVADOC概述
1 、javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。
2、行注释//是针对一小块代码做出解释的，而Javadoc的作用是针对整个方法或者整个类做一个简要的概述的，使得别人不通过看具体方法代码就能知道某个方法或者某个类的作用和功能。
JAVADOC
Javadoc可以写在类上面和方法上面。
一、写在类上
写在类上的文档标注一般分为三段：
第一段：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束
- @link的使用语法{@link 包名.类名#方法名(参数类型)}， 用于快速链接到相关代码
- @code的使用语法{@code text} 会被解析成
text，将文本标记为代码样式的文本
第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束
详细描述一般用一段或者几个锻炼来详细描述类的作用，详细描述中可以使用html标签，如<p>,<pr>,<a>,<ul>,<i>,等标签， 通常详细描述都以段落p标签开始。
详细描述和概要描述中间通常有一个空行来分割
- @param：一般类中支持泛型时会通过@param来解释泛型的类型
- @see：一般用于标记该类相关联的类,@see即可以用在类上，也可以用在方法上。
第三段：文档标注，用于标注作者、创建时间、参阅类等信息
- @since ：一般用于标记文件创建时项目当时对应的版本，一般后面跟版本号，也可以跟是一个时间，表示文件当前创建的时间
- @version ：用于标记当前版本，默认为1.0
- @author：详细描述后面一般使用@author来标记作者，如果一个文件有多个作者来维护就标记多个@author，@author 后面可以跟作者姓名(也可以附带邮箱地址)、组织名称(也可以附带组织官网地址)
二、写在方法上
写在方法上的文档标注一般分为三段：
第一段：概要描述，通常用一句或者一段话简要描述该方法的作用，以英文句号作为结束
第二段：详细描述，通常用一段或者多段话来详细描述该方法的作用，一般每段话都以英文句号作为结束
第三段：文档标注，用于标注参数、返回值、异常、参阅等
*方法详细描述上经常使用html标签来，通常都以p标签开始，而且p标签通常都是单标签，不使用结束标签，其中使用最多的就是p标签和pre标签,ul标签, i标签。
*一般p经常结合pre使用，或者pre结合@code共同使用(推荐@code方式)
*一般经常使用pre来举例如何使用方法
- @param： 后面跟参数名，再跟参数描述
- @return ：跟返回值的描述
- @throws： 跟异常类型 异常描述 , 用于描述方法内部可能抛出的异常
- @exception：用于描述方法签名throws对应的异常
- @inheritDoc：用于注解在重写方法或者子类上，用于继承父类中的Javadoc
基类的文档注释被继承到了子类
子类可以再加入自己的注释（特殊化扩展）
@return @param @throws 也会被继承 - @value：用于标注在常量上，{@value} 用于表示常量的值
