为全部导出API 元素编写文档注释（44）

一、JavaDoc 根据特殊的文档注释，能够自动生成api文档

• 文档注释应该简洁描述出他和客户端之间的约定
• 说清楚 方法作了什么，而不是怎么作的
• 文档注释应该列举出该方法的全部前提条件和后置条件
• 反作用也要描述清楚

前提条件

• @throws 标签针对未受检异常所隐含的描述

为了完整描述方法的约定

• @param  参数
• @return 返回值

@code 注解

@literal 注解

• 生成文档

同一个类或接口的成员或构造函数不该该有相同的概述

当为泛型或方法编写注解时，确保要在注解中说明全部的类型参数

当为枚举类型编写文档时

• 确保在文档中说明常量、类型，还有任何公有方法

类导出API的线程安全性和可序列化性

javadoc 具备继承方法注释的能力

• 接口的文档注释优于超类的文档注释