Javadoc
在学习JavaSE时,我们知道Java支持三种注释方式:
- 单行注释
- 多行注释
- 文档注释
Javadoc是文档注释,用来对类或方法进行标准的注释,在开发中写好JavaDoc非常重要。
在调用方法时,你可能会看到这样的情景
这种注释就是使用Javadoc来书写的,javadoc是目前很多公司都推荐使用的文档注释方式,能够更详细的说明方法的作用,各种参数的意义,以及返回值等。
我们平时用的API文档,就是利用javadoc提取出来的。
基本使用
Javadoc的基本结构是这样的:以/**
开头,以*/
结束
/**
*
*/
注意,开头必须是/**
,否则就会当做多行注释
然后利用内置的tag标签来说明,像这样
/**
* 检验用户登录
* @param username String类型的用户名
* @param password String类型的密码
* @return 返回一个封装好的User,如果用户名密码正确,则User不为空,否则为空
*/
显示出来的效果是这样的
给出一些常用的Tag标签
在使用时,书写完标签后,一定要空格,不要将标签与其他文本连接到一块,否则不会识别这个标签
常用的标签有@author、@version、@param、@return
在利用@param
标签对方法中的参数进行说明时,是这样用的
@param 参数名 解释说明
一个完成的Javadoc注释
/**
* 对这个方法或类或接口的功能描述
* @标签1 解释说明
* @标签2 解释说明
* @标签3 解释说明
*/
生成API文档
现在大部分的IDE已经集成了一键生成API文档的功能,以IDEA为例。
就会看到生成了很多网页文件