【Java基础】三种注释

一：注释

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

注释内容不会被编译

注释分为三种

1：单行注释（“//”）

eg:

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

2:多行注释（“/* ------------*/”）

eg:

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

3:文档注释

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

eg:

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

注意：在Java中有的注释是可以嵌套的

（1）多行注释：“/ *... * /”中可以嵌套使用单行注释“//”

eg:

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

(2) 多行注释“/ *... */”中不能嵌套使用多行注释“/*...* /”

/*
  /* int a = 10;*/
     int b = 5;
*/

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

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

感谢观看!!!