用javadoc工具自制java文档的注意点

        Java的API文档对于程序员来说如亲密爱人，时刻离不开。那么多sun公司定义的工具类和方法类，我们甚至都不知道有没有某个实现方法，就要去查找他的用法？有了API，这一切变得和查字典一样简单方便了。当我们做好了一个工具类的时候，我们也要自制一个java文档说明它的用法，也就是使用说明书。下面谈谈制作java文档需注意的几点：

一、注释必须是以/**开头,*/结尾。

二、注释中的@符号比价特殊，在类前的注释中加上@author :xiaohong和@version :1.0可以声明作者和版本号。@param和@return分别是用来声明参数和返回值的。

三、对一个成员方法进行说明时，注释语句应放在方法声明的上面。我之前放在方法体里面，生成文档后发现看不到效果。

.......

暂时只有这些了解，javadoc应该还有功能特性，有待进一步了解。