Javadoc真是个好东西。它简直太奇妙了,简直就是“懒人乐”。
其实,不仅仅是受“懒人”欢迎,它还有标准化、一元化等其他好处...
那么,懒人们可听好了:为了正确地编写API文档,你必须在每一个被导出的类、接口、构造函数、方法和域声明之前加上文档注释。每一个方法的文档注释应该简洁地描述出它和使用者之间的约定。
具体的@语法,这里就不介绍了。
【Effective Java 学习笔记】系列连载专题请见:
http://tonylian.iteye.com/categories/64208