Java中的注释

一、注释(Comment)

用于注解说明解释程序的文字就是注释.

单行注释和多行注释的作用:

1. 对多写的程序进行解释说明,增强可读性.方便自己,方便别人
2. 可以调试所写的代码
3. 特点:单行注释和多行注释,注释的内容不参与编译.
   换句话说,编译以后生成的.class结尾的字节码文件中不包含注释的信息.
4. 多行注释是不可以嵌套使用的

二、Java中的注释类型

1.单行注释

格式如下：

//  注释文字

2.多行注释

格式如下：

/*  注释文字  */

注:对于单行和多行注释,被注释的文字,不会被JVM(java虚拟机)解释运行.
多行注释里面不允许有多行注释嵌套.

3.文档注释(java特有)

格式如下:

/** 
	@author 指定java程序的作者  
	@version指定源文件的版本 		
*/

• 注释内容可以被JDK提供的工具javadoc所解析,生成一套以网页文件形式体现的该程序的说明文档.
• 操作方式:
  Javadoc -d 自定义文档名 -author -version java文件

---

总结

• 注释提高了代码的阅读性:调试程序的重要方法.
• 注释是一个程序员必须要具有的良好编程习惯.
• 将自己的思想通过注释先整理出来,再用代码去体现

使用javadoc生成说明文档时,有两点需要注意:
1.文件的编码为ANSII
2.Jdk1.6之后可以不需要配置classpath,否则会出现错位(此处只需要将JDK环境变量中的classpath路径删除即可)