Javadoc注释由Javadoc标签和描述性文本组成,你可以为类、接口添加注释,也可为构造函数、值域、方法等类中的元素添加注释。我们来看一个带Javadoc注释的程序,其代码如下所示:
代码清单 1 Person.java
1. package javadoc;
2. import java.io.Serializable;
3. /**
4. *
5. * @see javadoc.tool.Car
6. * @version 1.0, 2005-04-12
7. * @author 陈雄华
8. * @since JDK1.3
9. */
10. public class Person implements Serializable
11. {
12. /**男性,值为{@value}*/
13. public static final int MALE = 1;
14. /**女性,值为{@value}*/
15. public static final int FEMALE = 2;
16. /**名字*/
17. protected String name;
18. /**年龄*/
19. protected int sex;
20. /**
21. * 构造一个Person实例。设定Person的名字和性别。
22. *
23. * @param name String 名字
24. * @param sex int 性别,有效值是{@link #MALE 男性}和{@link #FEMALE}
25. * @throws PersonArgumentException
26. * @see javadoc.tool.Car#drive(int)
27. */
28. public Person(String name ,int sex) throws PersonArgumentException
29. {
30. if(sex != MALE && sex != FEMALE)