Javadoc文档注释

文档注释是为了用Javadoc工具自动生成API文档而写的注释，本文主要介绍文档注释的写法。
文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。
文档注释只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field)。相应地，文档注释必须写在类、接口、方法、构造器、成员字段前面，而写在其他位置，比如函数内部，是无效的文档注释。
文档注释主要由描述部分和标记部分组成，描述部分可以用html修饰符，标记部分以@符号开头。

类注释

类注释写在import语句之后，类定义之前。

/**
 * A{@code card}Object represents a playing card,
 * such as "Queen of Heart",a cardhas a suit(Diamand,
 * Heart,Spade or Club) and a Value(1=Ace,2...10,11=Jack,
 * 12=Queen,13=King)
 */
class Card {
	private String face;
	private String suit;

	public Card(String face, String suit) {
		this.face = face;
		this.suit = suit;
	}

	protected String getFace() {
		return face;
	}

	protected String getSuit() {
		return suit;
	}

	public String toString() {
		return suit + face;
	}
}

方法注释

每一个方法注释必须放在所注释的方法之前，可以使用以下标记
@param 参数描述
@return 返回值描述
@throws 抛出异常描述

    /**
     * @param an Integer Array 
     * @return a sorted Array
     * @throws ArithmeticException
     */
    public List<Integer> getSortedArray(){
		//...
    }

常量注释

通常只需要对静态常量添加文档注释

/**
 *The "Heart" card suit
 */
 public static final int HEART = 1;

通用注释

@author 作者
@version 版本
@since 可以是对引入特性的版本描述
@see 通常是链接
@link 同@see

生成javadoc

进入文件所在目录，javadoc -d docDirectory 文档名