Javadoc API文件产生器
Javadoc程序读取一个Java类文件并自动创建一组HTML文件,这些HTML 文件描述了Java类文件的类、变量、成员函数,所有Java类库的APIHTML 文件都可以由此程序创建。Javadoc把软件包名或源文件列表当做一个变量。Javadoc依靠以@打头的备注标记来创建HTML文件,下面就是标注的列表,它们被Javadoc用于在HTML 文件中创建链接。
选项 功能
@see classname 此标注在类列表中增加一个到所提供类的"See Also"条目。
@see classname # methodname 此标注创建一个到特定的成员函数的"See Also"条目。
@version text 此标注在HTML文件中加入一个版本信息条目
@author text 此标注在HTML文件中加入一个作者信息条目
@param name description 此标注用成员函数备注来描述一个成员函数所带变量
@return description 此标注用成员函数备注来描述返回值
@exception classname 此标注用成员函数备注来连接成员函数产生的异常出口
-classpath path 此命令行指定寻找Java文件的目录
-d directory 此命令行指定用来放入最终HTML文件十分有用。[@more@]
Javadoc程序读取一个Java类文件并自动创建一组HTML文件,这些HTML 文件描述了Java类文件的类、变量、成员函数,所有Java类库的APIHTML 文件都可以由此程序创建。Javadoc把软件包名或源文件列表当做一个变量。Javadoc依靠以@打头的备注标记来创建HTML文件,下面就是标注的列表,它们被Javadoc用于在HTML 文件中创建链接。
选项 功能
@see classname 此标注在类列表中增加一个到所提供类的"See Also"条目。
@see classname # methodname 此标注创建一个到特定的成员函数的"See Also"条目。
@version text 此标注在HTML文件中加入一个版本信息条目
@author text 此标注在HTML文件中加入一个作者信息条目
@param name description 此标注用成员函数备注来描述一个成员函数所带变量
@return description 此标注用成员函数备注来描述返回值
@exception classname 此标注用成员函数备注来连接成员函数产生的异常出口
-classpath path 此命令行指定寻找Java文件的目录
-d directory 此命令行指定用来放入最终HTML文件十分有用。[@more@]
来自 “ ITPUB博客 ” ,链接:http://blog.itpub.net/9650775/viewspace-923573/,如需转载,请注明出处,否则将追究法律责任。
转载于:http://blog.itpub.net/9650775/viewspace-923573/
本文介绍了Javadoc工具的基本功能,它能从Java类文件中自动生成HTML格式的API文档。通过使用特定的注释标签,开发者可以为类、变量、方法等元素添加详细说明,包括版本信息、作者、参数描述等内容。此外,还提供了命令行选项来指定Java源文件路径及输出目录。
3439

被折叠的 条评论
为什么被折叠?



