使用Javadoc标记你需要的信息

来源:百度文库 编辑:神马文学网 时间:2024/06/05 05:52:25
Java本身附带了一个很有用的工具Javadoc,它能将具有文档注释的类文件从源代码转换成Html格式。
Javadoc标记有两种:独立(Standalone)标记和内联(Inline)标记。独立标记也就是那些常见的标记,如@param, @return, 和@throws等。但还有一些不常见的,包括:
@author:这个标记答应你说明代码作者。它还能包含email地址、web站点以及其它有关作者的附加信息。
@since: 这个标记答应你指定类版本或者产品规格。Sun公司采用这种办法让用户知道JDK各个版本的特点。
@version: 这个标记答应你指定代码版本。你在这里放置的版本信息会由代码资料库自动插入源代码中去。例如,在CVS中,使用下列语法:
*@version $Id: Strings.java,v 1.1 2002/03/06 03:03:12 hen EXP $
则CVS将对其进行更新。在上述例子中,Strings.java是文件名,1.1是源代码的CVS版本号, 2002/03/006 03:03:12是代码放到CVS上的时间,hen则是放入代码的用户名称。
另一种类型的标记是内联标记。这种标记采用{@tag}的形式。在JDK1.2中,只有一种这样的标记{@link},它答应开发者创建超级链接从注释部分连接到其它的Javadoc页面或者本页面的其它地方。
link内联标记的通常形式是:
{@linkpackage.class#member label}
Label是位于注释中间的文本,package.class#member指向一个具体的类或者方法。 Label通常和类名或者方法名称相同。正如上述语法所显示,这个标记链接到其它类的任何成员,包括方法、属性、静态变量以及构造函数。以下是一些例子:
连接到同一类的属性,采用:
@link#KEY
以上不需要package.class,并且label名称就采用成员名称即可。
连接到同一类的方法,采用:
{@link#getComponentAt(int, int) getComponentAt}
连接到其它类,采用:
{@linkjava.util.Map Map}