【Java】Javadoc的使用

一、名词解释

javadoc是从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。

简单的来说，就是在Java中写注释，然后形成开发文档。Javadoc用于描述类或者方法的作用，可以写在类上面和方法上面。

https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html

二、写在类上

1. @link：{@link 包名.类名#方法名(参数类型)} 用于快速链接到相关代码
使用此文档标记的类或者方法，可用通过按住Ctrl键+单击 可以快速跳到相应的类或者方法上，解析成html其实就是使用< code> 包名.类名#方法名(参数类型)< /code>
2. @code： {@code text} 将文本标记为code
将文本标记为代码样式的文本，在code内部可以使用 < 、> 等不会被解释成html标签, code标签有自己的样式一般在Javadoc中只要涉及到类名或者方法名，都需要使用@code进行标记。
3. @param
一般类中支持泛型时会通过@param来解释泛型的类型
4. @author
详细描述后面一般使用@author来标记作者，如果一个文件有多个作者来维护就标记多个@author，@author 后面可以跟作者姓名(也可以附带邮箱地址)、组织名称(也可以附带组织官网地址)
5. @see
@see 一般用于标记该类相关联的类,@see即可以用在类上，也可以用在方法上。
6. @since 从以下版本开始
@since 一般用于标记文件创建时项目当时对应的版本，一般后面跟版本号，也可以跟是一个时间，表示文件当前创建的时间
7. @version 版本
@version 用于标记当前版本，默认为1.0

三、写在方法上

1. @param
@param 后面跟参数名，再跟参数描述
2. @return
@return 跟返回值的描述
3. @throws
@throws 跟异常类型 异常描述 , 用于描述方法内部可能抛出的异常
4. @exception
用于描述方法签名throws对应的异常
5. @see
@see既可以用来类上也可以用在方法上，表示可以参考的类或者方法
6. @value
用于标注在常量上，{@value} 用于表示常量的值
7. @inheritDoc
@inheritDoc用于注解在重写方法或者子类上，用于继承父类中的Javadoc

 

引用：https://blog.csdn.net/vbirdbest/article/details/80296136