JBuilder2005創(chuàng)建開發(fā)文檔之標簽介紹

字號:

Javadoc注釋由Javadoc標簽和描述性文本組成,你可以為類、接口添加注釋,也可為構造函數(shù)、值域、方法等類中的元素添加注釋。我們來看一個帶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)