当前页面: 开发资料首页 → JBuilder 专题 → JBuilder2005创建开发文档之标签介绍
摘要: JBuilder2005创建开发文档之标签介绍 Javadoc注释由Javadoc标签和描述性文本组成,你可以为类、接口添加注释,也可为构造函数、值域、方法等类中的元素添加注释。我们来看一个带Java...
1. package javadoc; 2. import java.io.Serializable; 3. /** 4. * <pre>描述人对象,拥有两个属性,分别是名字和性别。</pre> 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) 31. throw new PersonArgumentException("参数不正确"); 32. this.name = name; 33. this.sex = sex; 34. } 35. /** 36. * 获取性别代号。 37. * @return int 38. * @see MALE 39. * @see FEMALE 40. */ 41. public int getSex() 42. { 43. return sex; 44. } 45. /** 46. * 设置性别 47. * @param sex int 48. */ 49. public void setSex(int sex) 50. { 51. this.sex = sex; 52. } 53. } |
图 4 类注释 |
图 5 成员常量/变量注释摘要 |
图 6 方法摘要 |
图 7 构造函数详细描述 |
图 8 getSex()方法的详细说明 |
标签 | 说明 | JDK 1.1 doclet | 标准doclet | 标签类型 |
@author 作者 | 作者标识 | √ | √ | 包、 类、接口 |
@version 版本号 | 版本号 | √ | √ | 包、 类、接口 |
@param 参数名 描述 | 方法的入参名及描述信息,如入参有特别要求,可在此注释。 | √ | √ | 构造函数、 方法 |
@return 描述 | 对函数返回值的注释 | √ | √ | 方法 |
@deprecated 过期文本 | 标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
@throws异常类名 | 构造函数或方法所会抛出的异常。 | √ | 构造函数、 方法 | |
@exception 异常类名 | 同@throws。 | √ | √ | 构造函数、 方法 |
@see 引用 | 查看相关内容,如类、方法、变量等。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
@since 描述文本 | API在什么程序的什么版本后开发支持。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
{@link包.类#成员 标签} | 链接到某个特定的成员对应的文档中。 | √ | 包、类、接口、值域、构造函数、 方法 | |
{@value} | 当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。 | √(JDK1.4) | 静态值域 |
@see #getSex() @see #MALE |
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. } |
1. /** 2. * <pre>描述人对象,拥有两个属性,分别是名字和性别。</pre> 3. * @see javadoc.tool.Car 4. * @version 1.0, 2005-04-12 5. * @author 陈雄华 6. * @since JDK1.3 7. */ |
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. */ |