注释在许多编程语言中都是重要的一环,尤其在开发BS软件的java语言中,在经过一段时间的使用后需要更新升级时,如果没有注释的附加,代码的可读性就会变得非常差,使工作效率降低的同时,还增大了读代码错误发生的概率。
Java的注释分为三种形式
第一种形式:单行注释
//…
第二种形式:非文档注释
/…/
第三种形式:文档注释
/**…*/
前两种注释形式注释内容不会出现在javadoc 生成的文档中,而第三种形式的注释内容写入javadoc生成的文档中。
那么如何查看注释内容是否写入javadoc生成的文档中呢,假设有如下的源代码:
/**
*第一个java程序
*貌似还有点风趣
*/
public class HelloWorld{
public static void main(String [] args){
System.out.println("HelloWorld.");//代码搬运工上线
}
}
在JDK界面中输入:javadoc -d c:\help -author -version HelloWorld.java ,再编译运行一遍程序,将在c盘中出现一个文件help,打开文件中的“HelloWorld.html”,便可以看到这一文件中的文档注释了