单行注释和多行注释
1.用于说明某个类的用途、某个方法的功能，以及该方法的参数和返回值的数据类型及意义等。
2.用于调试程序，注释掉可能有错误的代码或打印信息看程序执行到哪里出错了。
单行注释 //
多行注释 /* 和 */
CommentTest.java
public class CommentTest {
/*
* 多行注释
*/
public static void main(String args[]) {
// 单行注释
System.out.println("Hello World");
// System.out.println("这行代码被注释了、将不会被编译、执行！");
}
}文档注释
用于生成API说明文档，告诉别人每个类、每个方法的功能及用法。
文档注释 /** 和 */
/**
* 类文档注释
*
* @author liweidong
*
* */
public class Javadoc {
/**
* 属性文档注释
*/
protected String name;
/**
* 主方法，程序的入口
*/
public static void main(String[] args) {
System.out.println("hello world");
}
}IDE工具生成文档实际上是使用了javadoc命令。
javadoc命令默认只处理public或protected修饰的内容。
javadoc标记：
@author:指定java程序的作者。
@version:指定源文件的版本
@deprecated：不推荐使用的方法。
@param:方法的参数说明信息。
@return:方法的返回值说明信息。
@see:"参见"，用于指定交叉参考的内容。
@exception:抛出异常的类型。
@throws:抛出的异常，和exception同义。
标记的位置限制
在类或接口可以出现的有:@see @deprecated @author @version
方法或构造器:@see @deprecated @param @return @throws @exception
Field文档注释中:@see @deprecated