JBuilder2005创建开发文档之标签介绍 - 编程入门网

@see #getSex() @see #MALE

也可以通过这个标签链接到其它类的方法、值域的说明处，假设我们创建一个称为javadoc的工程，在这个工程包括了代码清单 1的javadoc.Person.java文件，现在我们在工程中再添加一个javadoc.tool.Car类，其程序代码如下所示：

1.package javadoc.tool; 2. 3./** 4.* <pre>汽车对象类。</pre> 5.* @version 1.0, 2005-04-12 6.* @author 陈雄华 7.* @since JDK1.3 8.*/ 9.public class Car 10.{ 11.public Car() 12.{ 13.} 14./** 15.* 按某一方向驾驶汽车 16.* @param direction int 方法 17.* @param speed int 速度 18.*/ 19.public void drive(int direction,int speed) 20.{ 21./*do sth*/ 22.} 23./** 24.* 朝前驾驶汽车 25.* @param speed int 速度 26.*/ 27.public void drive(int speed) 28.{ 29./*do sth*/ 30.} 31.}

如果Person类和Car类有关系，我们就希望在Person的Javadoc文档中给出一个参见的Car文档的链接，以便开发人员能够顺藤摸瓜找到有联系的Car类的说明文档。要达到这一目的可以在Person类的注释中给出一个@see的标签。

1./** 2.* <pre>描述人对象，拥有两个属性，分别是名字和性别。</pre> 3.* @see javadoc.tool.Car 4.* @version 1.0, 2005-04-12 5.* @author 陈雄华 6.* @since JDK1.3 7.*/

请看第3行的@see标签，因为Car和Person类不在同一个包中，所以必须指定类的全名，当然，如果Person.java已经通过import chapter19.tool.Car;引入Car类，则@see可以直接用使用不带包的类名：@see Car。所以Javadoc中的@see引用注释和在Java代码中引用类是相似的。

一个更特别的应用场合是从当前文档中链接到重载方法，如Car中有两个drive()的重载方法，如何通过@see链接到不同的重载方法和注释中去呢？因为仅通过方法名无法定位，所以在方法名里面还需要指定入参的类型，请看下面的例子：

·@see javadoc.tool.Car#drive(int,int)：链接到drive(int direction,int speed)。

·@see javadoc.tool.Car#drive(int)：链接到drive(int speed)。

如果注释指定不正确，@see部分的注释将不出现在Javadoc文档中。

* @link

@link的@see很相似，唯一不同的是它可以嵌套在注释的描述文本中，在生成Javadoc文档时转换成一个关联链接。如Person的构造函数的注释中的@link：

1./** 2.* 构造一个Person实例。设定Person的名字和性别。 3.* 4.* @param name String 名字 5.* @param sex int 性别，有效值是{@link #MALE }和{@link #FEMALE} 6.* @throws PersonArgumentException 7.* @see javadoc.tool.Car#drive(int) 8.*/

带{}的Javadoc标签象一个变量，在转换成文档后，将替换成一个具体的值或链接。

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务，公司网站：http://www.lingzhong.cn 为了给广大客户了解更多的技术信息，本技术文章收集来源于网络,凌众科技尊重文章作者的版权，如果有涉及你的版权有必要删除你的文章，请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息，谢谢!