单行注释:从"//"开始到本行结束的内容都是注释,例如:
//这是一行单行注释
//则是另一行单行注释
多行注释:在"/*"和"*/"之间的所有内容都是注释,例如:
/*这是一段注释分布在多行之中*/
文档注释:在注释方面java提供一种C/C++所不具有的文档注释方式。其核心思想是当程序员编完程序以后,可以通过JDK提供的javadoc命令,生成所编程序的API文档,而该文档中的内容主要就是从文档注释中提取的。该API文档以HTML文件的形式出现,与java帮助文档的风格与形式完全一致。凡是在"/**"和"*/"之间的内容都是文档注释。例如下面的DocTest.java文件:
/** 这是一个文档注释的例子,主要介绍下面这个类 */
public class DocTest{
/** 变量注释,下面这个变量主要是充当整数计数 */
public int i;
/** 方法注释,下面这个方法的主要功能是计数 */
public void count( ) {}
}
|