为了使代码更具有可读性,在Java的编写过程中我们需要对一些代码段进行必要的注释,这样既能方便我们阅读,也能使别人更好的理解自己的程序。
Java的三种注释
java支持三种注释方式:
- 单行注释: // 注释内容
- 多行注释:/ * … 注释内容… . */
- 文本注释:/** … 注释内容… */
具体格式如下:
/*
*This is a comment.
*这是一个多行注释
*/
/**
*This is a comment.
*这是一个文本注释
*/
public class HelloWorld{
public static void main(String [] args){
System.out.println("HelloWorld"); //这是一个单行注释
}
}
多行注释与文本注释
为了更好的解释文本注释与多行注释的区别,我们在目录下打开cmd窗口并输入:
javadoc -d c:\help -author -version HelloWorld.java
(注: javadoc工具将你Java程序的源代码作为输入,输出一些包含你程序注释的HTML文件。
每一个类的信息将在独自的HTML文件里.javadoc也可以输出继承的树形结构和索引。)
在C盘中会发现生成了一个“help”文件夹,我们打开里面的“index.html”
通过生成的文档我们发现仅有文本注释的内容被保存起来,这也是文本注释与多行注释区别。文本注释能自动生成文档,使用这种方式注释源文件的内容,可以随着源文件的保存而被保存起来,你可以使用javadoc工具软件来生成信息,并输出到HTML文件中,听起来有些高大上。