JBuilder2005创建开发文档之标签介绍

Javadoc注释由Javadoc标记和描述性文本组成。您可以向类和接口以及类中的元素(如构造函数、范围和方法)添加注释。让我们看一个带有Javadoc注释的程序。其代码如下:

清单1 Person.java

1.打包javadoc

2.导入Java . io . serializable；

3./**

4.*描述person对象，该对象有两个属性，即姓名和性别。

5.* @参见javadoc.tool.Car

6.* @版本1.0，2005-04-12

7.* @作者陈

8.* @从JDK1.3开始

9.*/

10.公共类Person实现可序列化

11.{

12./**值为{@value}*/的男性

13.public static final int MALE = 1；

14./**值为{@value}*/的女性

15.public static final int FEMALE = 2；

16./**姓名*/

17.受保护的字符串名称；

18./**年龄*/

19.受保护的跨性别；

20./**

21.*构造一个Person实例。设置此人的姓名和性别。

22.*

23.* @param name字符串名称

24.* @param sex int gender，有效值为{@link #MALE}和{@link #FEMALE}

25.* @ throws PersonArgumentException

26.* @ see javadoc . tool . car # drive(int)

27.*/

28.public Person(String name，int sex)抛出PersonArgumentException

29.{

30.如果(性！=男&&性！=女性)