美文网首页
Java学习之注释

Java学习之注释

作者: 玉圣 | 来源:发表于2017-05-26 16:44 被阅读10次

在java中有三种书写注释的方式:“//...”、“/.../”、“/*.../”。(不带双引号“”,...代表被注释的内容)

1、“//”

这是一种最常使用的方式,此种注释只注释一行,即“//”所在行,也就是“//”后面的内容。在本行注释,有这么几个作用(本人心得啊):
1、方便自己查看:在下次看到代码后,自己可以更加快速的理解这句代码和所在代码块中的作用,以及对上下代码也更容易理解,而不用再一句一句的阅读源代码,从而节省很多时间。
2、方便其他人阅读:如果没有在必要的代码后面加上注释,别人就要把源代码的每一句都要阅读,不利于别人的阅读和其他程序员继续自己未完成的工作。
3、还有一点就是,加上一些注释,显得比较专业。(有些题外话了,不过看着确实如此)
如:

System.out.println("Hello World"); //打印字符串“Hello World”

2、“/.../”

对于一些较长的注释,也可以用”//“,但是这样就显得很麻烦,所以可以使用” /.../ “了,它用于注释若干行。比如说,在编写了很长一段代码后,编译运行后有很多错误出现,一查看,发现某个代码块有问题,这时候,你就可以将这段代码块注释掉,运行后发现问题解决了。这段注释掉的代码就可以用” /.../ “来注释。或者你需要在一段代码前写明这段代码的作用及方法等,也可以用” /.../ “
如:

    /* 
    查找数组中的元素 
    折半法:前提是数组是按大小顺序排列好的, 
          用查找的值和中间值比较,大则和下一半中间值比依次,小则和上一半中间值比,找到则返回。 
          小值的编号在左移或大值的编号在右移。判断是否大小值的编号相遇,若未找到,则不再循环,返回-1 
    */  
    public static int FindArry1(int[] arr,int key)  
    {  
        int min,max,mid;  
        min = 0;  
        max = arr.length-1;  
        mid = (min + max)/2;  
          
        //循环,查找中间值与要查找的值比较  
        while(key != arr[mid])  
        {  
            if (key > arr[mid])  
                min = mid +1;  
            else   
                max = mid - 1;  
            if (min > max)  
                return -1;  
            mid = (min + max)/2;  
        }  
        return mid;  
    }  

3、“/*.../”

这种注释可以用来自动地生成文档。在JDK中有个javadoc的工具,可以由源文件生成一个HTML文档。使用这种方式注释源文件的内容,显得很专业,并且可以随着源文件的保存而保存起来。也就是说,当修改源文件时,也可能对这个源代码的需求等一些注释性的文字进行修改,那么,这时候可以将源代码和文档一同保存,而不用再另外创建一个文档。
也可以用下面的方式将一些信息注释在源文件中:
如:

/** 
    这是一个简单的小程序: 
    @版本:1.7 
    @作者:玉圣 
*/  
class Demo  
{  
    public static void main(String [] args)  
    {  
        System.out.println("Hello World !");  
    }  
}  

需要注意的一点事,在第二种和第三种注释方式中不能使用嵌套,也就是说,在“/*...*/”和“/**...*/”的被注释部分不能再添加“ */ ”了,因为加入了之后,注释的部分就会在此结束,而后面的那个“ */ ”就是多出来的部分了,运行后就会报错:”非法表达式的开始“。

当然,第三种注释的形式还可以用到更多的地方,在以后的深入学习中会在继续补充。

相关文章

  • Java学习之注释

    在java中有三种书写注释的方式:“//...”、“/.../”、“/*.../”。(不带双引号“”,...代表被...

  • Java基础

    Java注释说明注释信息只保存在Java源代码文件中,不会存在于编译后的class文件中。点睛之笔//单行注释/*...

  • jsp基础知识学习

    1. jsp基础知识学习 1.1. jsp三种注释 html注释 java注释// 或者 /* */...

  • Java学习笔记

    Java基础 简单Java程序 Hello World 注释 java有三种注释:1.单行注释 2.多行注释 3....

  • javaSE回顾_02

    Java中的注释 Java中的注释有三种: 1. 单行注释——//注释内容 2. 多行注释——/* ...

  • Java中的注释、关键字、标识符

    Java中的注释 1. 单行注释 // 2. 多行注释 /* */ 3. 文档注释 /** */ Java中的关键...

  • Kotlin语言基础(二)

    3.6 代码注释 正如 Java 和 JavaScript,Kotlin 支持行注释及块注释。 与 Java 不同...

  • Java基础复习

    注释 Java语言的注释有三种 单行注释 多行注释 文档注释 CSDN中这篇文章详细描述了java文档注释的各种用...

  • 3.注释(Comment)

    含义:用于注解说明解释程序的文字就是注释 1.Java中的注释类型 单行注释 多行注释 文档注释(java特有) ...

  • scala(二) 变量与数据类型

    注释 scala 注释 与 java 完全一样// 单行注释/*...*/ 多行注释/**...*/ 文本注释注释...

网友评论

      本文标题:Java学习之注释

      本文链接:https://www.haomeiwen.com/subject/ixexfxtx.html