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文件十分有用。通过对它的使用,可让你在源代码中加入更多的注释,这对提高程序的可读性来说是非常有用的。
标记 功能
──────────────────────────────────
@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文件十分有用。通过对它的使用,可让你在源代码中加入更多的注释,这对提高程序的可读性来说是非常有用的。
解决方案 »
- 又是关于日期的问题
- 关于installinshield2008的使用教程
- 导出oracle出错java.lang.OutOfMemoryError: Java heap space
- 问一个JDesktopPane问题
- 窗口监听事件问题
- JAVA怎么获得C程序(是编译后的.exe)的返回值?
- 用jdbc读取数据的时候,有这个警告:但是不影响读取数据
- 请问:如果java代码的文件包压缩后的扩展名是tar.gz
- 用java applet写email发送程序怎样通过安全认证?
- 怎么运行JAVA时总是: Exception in thread “main” java.lang.NoClassDefFoundError
- 还是环境变量设置问题!不好意思!!
- 为什么 jb7下作jsp时 session.getValue() 中的 getValue() 是带横杠的? 什么意思?怎么解决?
用jbuilder打开你的工程,点选Doc标签生成doc然后在工程放置的目录下就可以找到doc了