2.7 Javadoc API文件产生器

飘雪

[center]2.7　Javadoc API文件产生器[/center]

　　Javadoc程序读取一个Java类文件并自动创建一组HTML文件，这些HTML 文件描述了Java类文件的类、变量、成员函数，所有Java类库的APIHTML 文件都可以由此程序创建。Javadoc把软件包名或源文件列表当做一个变量。Javadoc依靠以＠打头的备注标记来创建HTML文件，下面就是标注的列表，它们被Javadoc用于在HTML 文件中创建链接。

　　　　　　标记　　　　　　　　　　　　  功能
　　──────────────────────────────────
　　＠see classname　　　　　　 此标注在类列表中增加一个到所提供类的
　　　　　　　　　　　　　　　　"See Also"条目。
　　＠see classname # method-   此标注创建一个到特定的成员函数的"See
　　 name　　　　　　　　　　   Also"条目。
　　＠version text　　　　　　  此标注在HTML文件中加入一个版本信息条目
　　＠author text　　　　　　   此标注在HTML文件中加入一个作者信息条目
　　＠param name description　　此标注用成员函数备注来描述一个成员函数
　　　　　　　　　　　　　　　　所带变量
　　＠return description　　　　此标注用成员函数备注来描述返回值
　　＠exception classname　　   此标注用成员函数备注来连接成员函数产生
　　　　　　　　　　　　　　　　的异常出口

　　　　　　　　 表2-6 Javadoc所用的标记


　　除此以外，Javadoc还可以使用两个命令行参数：
　　-classpath path
　　此命令行指定寻找Java文件的目录
　　-d directory
　　此命令行指定用来放入最终HTML文件十分有用。通过对它的使用，可让你在源代码中加入更多的注释，这对提高程序的可读性来说是非常有用的。