JBuilder2005创建开发文档之标签介绍 (3)
[ 来源:互网络 | 更新日期:2007-09-26 21:56:28 | 浏览次数:7962]
简介:java 1
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. */


您的位置:
