注释和注解

注释

单行注释

// 单行注释内容

多行注释

/*
注释内容
*/

文档注释

/**
文档注释内容
*/

使用文档生成工具软件（\JDK安装目录下的\bin\javadoc.exe）自动生成说明文档，减轻程序员编写说明文档的工作量。

例：

package Api;
/**
 * 类功能简介：TEST是一个测试类，添加了文档注释
 * @author PC214
 *
 */
public class TEST {
	private int a,b,c;//私有成员不对外开放，不需要添加文档注释
	/**
	 * get方法
	 * @return
	 */
	public int getA() {
		return a;
	}
	/**
	 * set方法
	 * @param a
	 */
	public void setA(int a) {
		this.a = a;
	}
	/**
	 * toString()方法
	 */
	@Override
	public String toString() {
		return "TEST [a=" + a + ", b=" + b + ", c=" + c + "]";
	}
	/**
	 * 构造方法
	 */
	public TEST(int h,int m,int s) {//构造方法
		a = h; b = m; c = s;
	}

}

举例：

javadoc标记说明

注意：javadoc针对public类生成注释文档

注解

用于规范文档注释中的某些关键信息，例如程序作者，方法的参数或返回值等说明信息。

注解主要用途是在类定义代码中插入附加信息。

元注解

定义在java.lang.annotation包中

Java API预定义注解

参考