提示五十六：为所有导出的API元素写文档注释

第56条：为所有导出的API元素写文档注释。

1. 为了正确的编写API文档，必须在每个被导出的类、接口、构造器、方法和域声明之前增加一个文档注释。
2. 同一个类或接口中的两个成员或者构造器，不应该具有相同的概要描述。
3. 如果代码中出现了泛型，确保要在文档中说明所有的类型参数。
4. 为枚举类型编写文档时，要确保在文档中说明常量。
5. 为注解编写文档时，要说明清楚所有成员。
6. 类或者静态方法是否线程安全，应该在文档中进行声明。

这一章作者主要还是站在一个较高的视角来考虑问题。确实一般也只在一些封装好的API中见过文档注释，平时写代码一般不会使用这一套。但是有时候遇到一些trick难懂的地方，我也会写一些注释来解释代码这样做的原因，如果想让自己的代码被更多的人使用，文档注释这一套还是很有必要的。