javadoc
类
类上的注解一般分为三段
- 概要描述：通常用一句话或一段话简要描述该类的作用，已英文句号作为结束
- 详细描述：通常用一段话或多端话来详细描述该类的作用，一般每段话都已英文句号作为结束
- 文档标注：用于标注作者、创建时间等信息
文档标记
注释中已@开头的被称之为javadoc文档标记
| 标记 | 作用 |
|---|---|
| @link | 用于快速连接到相关代码 |
| @code | 将文本标记为code |
| @param | 用来解释泛型类型 |
| @author | 标记作者 |
| @see | 标记该类相关联的类 |
| @since | 从一下版本开始 |
| @version | 标记当前版本 |
方法
方法上的注解一般分为三段
- 概要描述：通常用一句话或者一段话简要描述该方法的作用，以英文句号作为结束
- 详细描述：通常用一段话或多段话来详细描述该方法的作用，一般每段话都已英文句号作为结束
- 文档标注：用于标注参数、返回值、异常、参阅等
文档标记
| 标记 | 作用 |
|---|---|
| @param | 后面跟参数名，再跟参数描述 |
| @return | 返回值的描述 |
| @throws | 异常类型，异常描述 |
| @exception | 描述方法签名throws对应的异常 |
| @see | 参考类或参考方法 |
| @value | 表示常量的值 |
| @inheritDoc | 用在重写方法和子类上，用于继承父类中的javadoc |
