痛点
一句话,形成生成接口文档的规范.
什么是JavaDOC
根据代码中的注释信息,生成Api文档
JavaDoc使用方法
在了解JavaDoc之前, 我们必须知道Java的三种注释方式.
Java的三种注释方法
-
单行注释
//这是单行注释 -
多行注释
/* 这是多行注释 */ -
文档注释
/** * 这是文档注释 */
参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
