【java】注释

二、Java中的注释

Java中的注释

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

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

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

1.单行注释

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

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

2.多行注释

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

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

3.文档注释

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

/**
*Title:HelloNorid类

*@author srx

*@version 1.0

*/

public class Helloworld {

/**
*这是一个 main ()方法人口

* @param args 参数名

*/

    public static void main(String[] args){

        System.out .printitln("这是第一个 Java程序!");

    }

}
           

注意：

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

  int x=5;*/
           

/*
  
    /*int c=10;*/

*/