What is Javadoc and how to use it?

What is Javadoc and how to use it?

1.WHAT
Javadoc用于描述类或者方法的作用。

2.HOW
【1】写在类上面的Javadoc

(1)概要描述，通常用一句或者一段话描述该类的作用，以英文句号作为结束

以@开头的东西叫做Javadoc文档标记，是JDK定义好的,如下所示：

@link的使用语法
{@link 包名.类名#方法名(参数类型)}
其中当包名在当前类中已经导入了包名可以省略，可以只是一个类名，也可以只是一个方法名，也可以是类名.方法名，使用此文档标记的类或者方法，可以用按住 Ctrl键+单击 可以快速跳到相应的 类或者方法上，解析成html其实就是使用< code>包名.类名#方法名（参数类型）< /code>

{@code text}会被解析为< code> text < /code>
将文本标记为代码样式的文本，在code内部可以使用< 、 > 等不会被解释成HTML标签，code标签有自己的样式
一般在Javadoc中只要涉及到类名或者方法名，都需要使用@code进行标记。

(2)详细描述，通常用一段或多段话来详细描述该类的作用，一般每段话都以英文句号作为结尾
详细描述一般用一段或者几个段落来详细的描述类的作用，详细描述中可以使用html标签，如 < p >、< pre >、< a >、< ul >、< i >等标签，通常详细描述都以段落P标签开始。
详细描述和概要描述中间通常有一个空行来分割

一般段落都用p标签来标记，凡涉及到类名和方法名都用@code标记，凡涉及到组织的，一般用a标签提供出来链接地址。

@param
一般类中支持泛型时会通过@param来解释泛型的类型

@author
详细描述后面一般使用@author来标记作者，如果一个文件有多个作者来维护就标记多个@author，@author 后面可以跟作者姓名(也可以附带邮箱地址)、组织名称(也可以附带组织官网地址)

@see另请参阅
@see 一般用于标记该类相关联的类,@see即可以用在类上，也可以用在方法上。

@since从以下版本开始
@since 一般用于标记文件创建时项目当时对应的版本，一般后面跟版本号，也可以跟是一个时间，表示文件当前创建的时间

@version版本
@version 用于标记当前版本，默认为1.0

（3）文档标注，用于标注作者、创建时间、参阅类等信息

【2】写在方法上的Javadoc
(1) (2)与类（1）（2）相似
（3）文档标注，用于标注参数、返回值、异常、参阅等

方法详细描述上经常使用html标签来，通常都以p标签开始，而且p标签通常都是单标签，不使用结束标签，其中使用最多的就是p标签和pre标签,ul标签, i标签。

pre元素可定义预格式化的文本。被包围在pre元素中的文本通常会保留空格和换行符。而文本也会呈现为等宽字体，pre标签的一个常见应用就是用来表示计算机的源代码。

一般p经常结合pre使用，或者pre结合@code共同使用(推荐@code方式)
一般经常使用pre来举例如何使用方法

注意：pre>标签中如果有小于号、大于号、例如泛型 在生产javadoc时会报错

@param
@param 后面跟参数名，再跟参数描述
@return
@return 跟返回值的描述

@throws
@throws 跟异常类型 异常描述 , 用于描述方法内部可能抛出的异常
@exception
用于描述方法签名throws对应的异常

@see
@see既可以用来类上也可以用在方法上，表示可以参考的类或者方法

@value
用于标注在常量上，{@value} 用于表示常量的值

@inheritDoc
@inheritDoc用于注解在重写方法或者子类上，用于继承父类中的Javadoc

1.基类的文档注释被继承到了子类

2.子类可以再加入自己的注释（特殊化扩展）

3.@return @param @throws 也会被继承