在Java的编写过程中我们需要对一些程序进行注释,除了自己和他人方便阅读,更为以后的程序优化提供了方便,因此我们需要一些注释,这些注释可以是编程思路或者是程序的作用,总而言之,就是方便自己他人更好的阅读和系统的维护。
在Java中根据注释的功能不同,主要分为单行注释、多行注释和文档注释。
* //.......单行注释,“//”后面的单行内容均为注释。
* /*......*/多行注释,注释内容不会出现在javadoc生成的文档中。
* /**.....*/文档注释,注释内容写入javadoc生成的文档中。
首先,我们需要先写一个Java代码,以HelloWorld为例:
public class HelloWorld{
public static void main(String [] args){
System.out.println("HelloWorld");
}
}
对该代码加入单行注释和文档注释:
/**
*this is a comment!
*!
*/
public class HelloWorld{
public static void main(String [] args){
System.out.println("HelloWorld");//单行注释
}
}
其次,在“HelloWorld.java”文件所在地址栏输入“cmd”,回车,在弹出框的光标处输入 “javadoc -d c:\help -author -version HelloWorld.java”,回车后,即得到javadoc生成的文档,
然后,在C盘找到help文件夹,打开“HelloWorld.html”,可看到如下内容:
************************************************************************************************************************************************
由此,我们可以发现用/**.....*/注释的内容,即文档注释的注释内容会出现在javadoc生成的文档中;而//.....注释的内容,即单行注释的内容不会出现在javadoc生成的文档中;进一步使用/*.....*/多行注释,会发现注释内容也未出现在javadoc生成的文档中。