Java基础-注释

注释

我们在学习Java之前，就需要先学会写注释，注释就是为了让我们对代码看的更加的清晰，它是给我们自己看的，也是给别人看的，就是为了解释我们的程序所编写的，注释不会被程序编译和执行，编写代码是为了让程序读起来更加的清晰明了，养成良好的代码注释习惯是一个程序员应该做到的基础之一，下面我们对Java的注释做一些整理。

1.单行注释

单行注释一般采用 //+注释内容 来标注，它只能注释当前一行的内容，一般用于某句代码的简单解释。如下代码，就包含一个单行注释：

// 输出一个Hello World
System.out.println("Hello,World!");

2.多行注释

多行注释采用 /*+注释内容+*/ 来标注，很明显，它能注释多行的内容，比如我们写的一些代码块或者对某段程序的解释说明较为复杂时，我们就可以采用多行注释。

/*
  下面这两行代码被多行注释注释掉了 不会被执行
  int i = Integer.parseInt("100");
  System.out.println(i);
*/
System.out.println("Hello,World!");

3.文档注释

文档注释采用 /**+注释内容+*/ 来标注，它一般用于对方法或者类的解释说明，一个好的文档注释可以通过javadoc工具生成一份通俗易懂的文档手册。

/**
  @Author Ara_Hu
  @Description 这个方法用于两个变量的相加计算
  @Date 2020/1/16 11:56
  @Param [a, b] 两个计算变量
  @Return 相加后的结果
*/
public static double add(double a, double b) {
    return a + b;
}