Java中的三种注释类型

注释：用于说明解释程序的文字就是注释。

Java中的注释有三种：

• 单行注释
• 多行注释
• 文档注释（Java特有）

注释的作用有什么？

主要就是提高了代码的阅读性，是调试程序的重要方法。

当然，写注释也是一种良好编程习惯。可以将自己的思想通过注释先整理出来，再用代码去体现。

来看看具体的使用吧！

单行注释
格式： //注释文字

多行注释
格式： /* 注释文字 */

下面给出单行注释和多行注释的示例：

//单行注释
public class HelloWorld{
    
    /*
    	程序入口
    */
    public static void main(String args[]){
        System.out.println("HelloWorld!");
    }
    
}

注：对于单行和多行注释，被注释的文字，不会被JVM（java虚拟机）解释执行。多行注释里面不允许有多行注释嵌套。

来试试先：

public class HelloWorld{
    
    /*
    程序入口
    	
    /*
    会报错吗？
    */
    
    */
    public static void main(String args[]){
        System.out.println("HelloWorld!");
    }
    
}

运行一下：

多行注释不能嵌套多行注释是因为在注释时，"/*" 是去匹配第一个遇到的" /",后面的 "/"一律视为注释内容。

文档格式（Java特有）
格式：/**
@author 指定java 程序的作者
@version 指定源文件的版本
*/

注释内容可以被JDK提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档。

操作一下：

/**
    @author chunni
    @version v1.0
    第一个Java程序！
*/
public class HelloWorld{
    
    /*
     程序主入口，main函数
    */
    public static void main(String args[]){
        System.out.println("HelloWorld!");
    }
    
}

命令行窗口输入：javadoc -d 生成的文件名 -author -version HelloWorld.java

此时发现原来代码目录下出现么mydoc文件夹。

点进mydoc文件夹打开index.html就可以查看doc文档了