作为程序员,无论用什么语言开发程序,最基本的一点思想之一就是不仅仅是要自己看懂自己编写的代码,更要努力去让其他程序员看懂自己的代码,退一万步讲,也要让不懂代码的人知道,每一串代码或某一句代码执行的功能与命令,那么在程序的编写中势必就少不了注释的添加,今天就了解一下Java程序中添加注释的方式。
在Java程序中存在的注释方式有三种,如下:
1)//.............单行注释,注释内容不会出现在javadoc生成的文档中。
2)/*..........*/多行注释(又称非文本注释),注释内容不会出现在javadoc生成的文档中。
3)/**........*/多行注释(又称文本注释),注释内容会写入javadoc生成的文档。
/**
* 多行注释(写入文档)
* author_刘晓阳
*/
public class HelloWorld{
/*
* 多行注释(不写入文档)
*/
public static void main(String [] arg){
System.out.println("HelloWorld!"); //单行注释(不写入文档)
}
}
执行命令
javadoc -d d:\test -author -version HelloWorld.java
窗口如图:
D盘test文件夹 index.html ,结果如下图:
如图所示,只有3)类多行注释内容写入文档。
那么三类注释方法在Java中的存在方式就清晰可见了。