从0复习Java——注释

注释

在编写Java代码时，为了方便阅读，常常需要对某一行或一段代码进行解释，来说明一个类或者一个方法的作用，参数和返回值的数据类型和意义

为什么要使用注释

1. 对于自己编写的代码，如果代码复杂，行数过多，随着时间的增加，当我们再次观看代码时很可能会忘记某一段代码的功能和意义，若使用注释来解释则可以帮助我们再次理解代码的思路和意义
2. 在实际开发过程中，一个程序需要一个团队共同开发，自己所编写的代码和其他人编写的代码都需要让其他人能够理解

总而言之，注释的存在可以使代码的可读性增加，使得自己和其他人更好的理解一段代码

Java注释

在Java中，一共有三种注释方式，添加注释可以提高代码的阅读性，且对代码的执行内容不产生任何影响

一. 单行注释

单行注释以//作为开头，注释内容在//之后直到本行末尾

// 这是一段单行注释
// 这是一个HelloWorld类
public class HelloWorld {
    // 这是一个main方法
    public static void main(String[] args) {
        // 这是一个输出语句
        System.out.println("Hello, World!");
    }
}

二. 多行注释

多行注释以/*开头，以*/结尾，在这个范围内的所有内容都被认为是注释内容
多行注释可以注释一行，也可以注释多行

/*
   这是一个HelloWorld类
   其中main方法的输出语句可以将Hello, World!输出到显示器
*/
public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
/* 
   这是一段多行注释
   多行注释可以注释多行
   在这个范围内都被认为是注释内容
   class a{
        public void print(){
            System.out.println("A");
        }
   }
   这个范围内的Java代码也会被注释
*/
/*多行注释可以注释单行*/

注意：在多行注释不能进行嵌套

三. 文档注释

文档注释以/**开头，并以*/结尾
之后，你可以包含一个或多个各种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号*

/**
 * 这是一个HelloWorld类
 * 
 * @author Melonico
 * @version 1.0
 */
public class HelloWorld {
    /**
     * 这是一个main方法
     * 
     * @param args 命令行参数
     */
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}