详述Java注释

Java注释的基本语句

//......单行注释
/*......*/多行注释，但注释内容不会出现在javadoc生成的文档中
/**.....*/多行注释，注释内容写入javadoc生成的文档

代码示例

代码①：单行注释

public class HelloWorld{

	public static void main(String [] args){
		System.out.println("HelloWorld");//这是一个输出
	}
}

代码②：多行注释在javadoc生产文档中出现

/**
 *这是一个注释
 *多行的
 *且可以显示在javadoc生成的文档中
 */
public class HelloWorld{

	public static void main(String [] args){
		System.out.println("HelloWorld");
	}
}

代码③：多行注释不在javadoc生产文档中出现

/*
 *这是一个注释
 *多行的
 *但不可以显示在javadoc生成的文档中
 */
public class HelloWorld{

	public static void main(String [] args){
		System.out.println("HelloWorld");
	}
}

检验过程

要检验三种注释是否有所区别，这里需要用到Java的一种输出语句

javadoc -d c:\help -author -version HelloWorld.java

该输出语句能够在指定位置生成help文件夹，包含程序信息
———————————————————————————————————————————————————————
首先，我们检验“//”单行注释符
首先对代码①编译后，输入“javadoc -d c:\help -author -version HelloWorld.java”语句

运行结果如下

接下来我们去c:\help文件夹中找到index.html文件，打开

发现并没有显示注释内容“这是一个输出”
———————————————————————————————————————————————————————

我们再来检验多行注释符/…*/**
将代码②编译再输入“javadoc -d c:\help -author -version HelloWorld.java”语句，运行，index.html视图如下
出现了我们代码①中插入的注释语句
———————————————————————————————————————————————————————

最后来测试多行注释符/…/
同样，编译后输入“javadoc -d c:\help -author -version HelloWorld.java”语句，index.html视图如下
没有显示代码③中的注释内容

到此我们已经证明了上述三种注释语句不同之处

小结

大家可以根据需要选择单行注释或者是多行注释
但要注意使用多行注释符时，要把上下的星号对齐，这样才能正确显示注释内容