javadoc 标签介绍

参考链接:
http://hi.baidu.com/luanxian/blog/item/7cd60808334d6fd263d9860e.html
http://www.java.sun.com/j2se/javadoc

测试类
Persion
package javadoc;                                                     
import java.io.Serializable;                                         
/**                                                                  
*                                                                    
描述人对象,拥有两个属性,分别是名字和性别。                         
                                                                     
* @see javadoc.tool.Car                                              
* @version 1.0, 2005-04-12                                           
* @author 陈雄华                                                     
* @since JDK1.3                                                      
*/                                                                   

public class Person implements Serializable {
	/** 男性,值为{@value} */
	public static final int MALE = 1;
	/** 女性,值为{@value} */
	public static final int FEMALE = 2;
	/** 名字 */
	protected String name;
	/** 年龄 */
	protected int sex;                                                
	/**                                                               
	* 构造一个Person实例。设定Person的名字和性别。                    
	*                                                                 
	* @param name String 名字                                         
	* @param sex int 性别,有效值是{@link #MALE 男性}和{@link #FEMALE}
	* @throws PersonArgumentException                                 
	* @see javadoc.tool.Car#drive(int)                                
	*/                                                                

	public Person(String name, int sex) throws Exception {
		if (sex != MALE && sex != FEMALE)
			throw new Exception("参数不正确");
		this.name = name;
		this.sex = sex;
	}                                                                 
	/**                                                               
	* 获取性别代号。                                                  
	* @return int                                                     
	* @see MALE                                                       
	* @see FEMALE                                                     
	*/                                                                

	public int getSex() {
		return sex;
	}                                                                 
	/**                                                               
	* 设置性别                                                        
	* @param sex int                                                  
	*/                                                                

	public void setSex(int sex) {
		this.sex = sex;
	}
}                                                                   


Car.java
package javadoc.tool;
	/**
	* 汽车对象类。
	* @version 1.0, 2005-04-126. 
	* @author 陈雄华
	* @since JDK1.38. */
public class Car {
	public Car() {
	} 
	/**
	* 按某一方向驾驶汽车
	* @param direction int 方法
	* @param speed int 速度
	*/
	public void drive(int direction, int speed) {
		/* do sth */
	} 
	/**
	* 朝前驾驶汽车
	* @param speed int 速度
	*/
	public void drive(int speed) {
		/* do sth */
	}
}

你可能感兴趣的:(java,html,J2SE,Blog,sun)