JavaDoc文档的编写

     Java源文件中，只有满足下面条件才会生成JavaDoc文档：

•       只有文本注释才能生成JavaDoc文档，即以“/**”开始，并以“*/”结束的注释。
•      Java源文件中在类声明、接口声明、成员方法声明、成员变量声明及构造方法之前的注释才能生成JavaDoc文档，其他地方的注释会忽略。

下面是一个例子：

/**
 * 这是一个JavaDoc使用的例子。
 * 
 */
package com.fengyun.bam.part1;

/**
 * <p><strong>JavaDocDemo</strong>中使用了各种JavaDoc标记</p>
 * 类的注释语句
 * @author administrator
 * @version 3.0
 * @since 1.0
 * @see com.fengyun.bam.part1.Bank
 */
public class JavaDocDemo {
	/**
	 * 成员变量的注释语句
	 */
	public String i ;
	
	/**
	 * 构造方法的注释语句
	 */
	public JavaDocDemo() {
		this.i="Hello,world!";
	}
	/**
	 * 成员方法的注释语句
	 * @param name 你的名字
	 * @return 返回类类型
	 * @deprecated 该方法已经被废弃
	 * @since 2.0
	 * @exception 抛出异常
	 */
	public JavaDocDemo output(String name) {
		System.out.println(name+",\t"+i);
		return null;
	}
	public static void main(String[] args) {
		JavaDocDemo j=new JavaDocDemo();
		j.output("Lily");
	}
}

 

         局部变量的注释、关键字package之前的注释等会被忽略。

     注释里面可以包含普通文本、HTML标记和JavaDoc标记。

• @version 指明该程序的版本。
• @since 指明程序代码最早出现在哪个版本中。对于类中的成员变量和成员方法，惯例的做法是，在默认情况下，假定它们在类的最早版本中就出现了，否则，就用@since明确表明它们最早出现的版本。
• @deprecated 用来表明被注释的类、变量、方法已经不提倡使用。
• @see 用于生成参考其他JavaDoc文档的连接

                  链接其他类的JavaDoc文档，必须给出完整的类名。如：@see com.fengyun.bam.exception.ATMException

                  链接当前类的方法或变量的JavaDoc文档，如：@see #output

                  链接其他类的方法或变量的JavaDoc文档，如：@see com.fengyun.bam.exception.ATMException#output

• @link 为注释语句中特定词汇生成链接，如：/**这是类的｛@link #i 成员变量｝。 */
• @param 描述方法的参数。
• @return 描述方法的返回值。
• @exception、@throws  描述方法的抛出异常，指明抛出的条件。