59859cc威尼斯官网-威尼斯欢乐娱人成app

教育行业A股IPO第一股(股票代码 003032)

全国咨询/投诉热线:400-618-4000

传智教育|传智播客

一样的教育,不一样的品质

全国校区

 

为什么要给代码添加注释?Java中的注释有几种

更新时间:2021年06月28日15时33分 来源:传智教育 浏览次数:

传智教育-一样的教育,不一样的品质


在编写程序时,为了使代码易于阅读,通常会在实现功能的同时为代码添加一些注释。注释是对程序的某个功能或者某行代码的说明说明,它能够让开发者在后期阅读和使用代码时能更容易理解代码的作用。

注释只在Java源文件中有效,在编译程序时编译器会忽略这些注释信息,不会将其编译到class字节码文件中。

Java中的注释有三种类型,具体如下:


1.单行注释

单行注释通常用于对程序中的某一行代码进行说明,用符号“//”表示,“//”后面为被注释的内容,具体示例如下:

int c = 10;      // 定义一个整型变量c

2.多行注释

多行注释顾名思义就是可以同时为多行内容进行统一注释,它以符号“/”开头,并以符号“/”结尾,具体示例如下:

/* 定义一个整形变量x
将5赋值给变量x */
int x;
x = 5;

3.文档注释

文档注释通常是对程序中某个类或类中的方法进行的系统性的说明说明,开发人员可以使用JDK提供的javadoc工具将文档注释提取出来生成一份API帮助文档。文档注释以符号“/”开头,并以符号“/”结尾,具体示例如下:

/**
 * Title:HelloWorld类
 * @author srx
 * @version 1.0    
 */
public class HelloWorld {
    /**
     * 这是一个main()方法入口
     * @param args 参数名
     */
    public static void main(String[] args){
        System.out.println("这是第一个Java程序!");
    }
}


注释嵌套:

在Java中,有的注释可以嵌套使用,有的则不可以,下面列举两种具体的情况。

1.多行注释“/…/”中可以嵌套使用单行注释“//”,具体示例如下:

/* int c = 10;  // 定义一个整型的c
  int x = 5; */


2.多行注释“/…/”中不能嵌套使用多行注释“/…/”,具体示例如下:

/*
  /*int c = 10;*/
  int x=5;
*/

上面第二种情况的代码就无法通过编译,原因在于第一个 “/”会和第一个“/”进行配对,而第二个“*/”则找不到匹配,就会编译失败。

针对在使用嵌套注释时可能出现编译异常这一问题,通常在实际开发中都会避免对代码注释进行嵌套使用,只有在特殊情况下才会在多行注释中嵌套使用单行注释。








猜你喜欢:

Java中有多少个关键字?使用关键字应当注意什么

volatile关键字的作用,看完你明白了!

Java语言中的标识符规则有哪些

传智教育Java开发培训

59859cc威尼斯官网|威尼斯欢乐娱人成app

XML 地图 | Sitemap 地图