当前位置 博文首页 > AI_Qpeng的博客:Java中的注释

    AI_Qpeng的博客:Java中的注释

    作者:[db:作者] 时间:2021-07-06 16:40

    像其他编程语言一样,Java也有自己的注释方式,而写注释也是编写程序时所必须的,它对后期的程序维护和更新等有着重要的作用,方便程序员了解每一段代码是用来干什么的。在Java中,有单行注释和多行注释两种注释方式,其中多行注释又有单“*”注释和双“**”注释两种方式。

    示例:

    单行注释:

    ?

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

    单“*”多行注释:

    /*
    *双行注释
    *内容
    ...
    */
    public class HelloWorld{
    	
    	public static void main(String [] args){
    		System.out.println("HelloWorld");
    	}
    }

    双“**”多行注释:

    /**
    *双行注释
    *内容
    ...
    */
    public class HelloWorld{
    	
    	public static void main(String [] args){
    		System.out.println("HelloWorld");
    	}
    }

    这三种注释方式除了形式上的区别,还有一种区别体现在用Javadoc命令生成的帮助文档中,用该命令将Java源代码中的某些文档注释生成帮助文档后,单行注释和单“*”多行注释中的注释内容不会显示在帮助文档中,而双“**”多行注释则会显示注释内容。

    示例:

    在DOS窗口中键入javadoc -d c:\help -author -version HelloWorld.java命令,出现以下内容(源程序中为上面双“**”多行注释的示例)

    之后C盘中会出现一个名为“help”的文件夹,打开其中的index.html,即可看到以下内容

    但是另外两种注释则不会出现上图所画出的内容,即不会出现注释内容。

    在使用这些注释时,要注意稍微区分一下这些注释方式的不同。

    cs