Java注释

Posted 2021-12-09 程序员老陆

目录

​​1 Java 注释​​

​​Java 多行注释​​

​​3 Java 文档注释​​

---

1 Java 注释

您可以在Java代码中包含注释，这将提高源代码的可读性。

Java 支持单行以及多行注释。注释中的字符将被 Java 编译器忽略。

Java 单行注释以 // 开始，直到行尾为止。例如：

// 这是一个单行注释
x = 10; // 代码后的单行注释

单行注释也能以 /* 开始，以 */为止。例如：

/* 这也是一个单行注释 */

提示：在编写代码时添加注释是一种很好的做法，因为当你需要回顾它时，以及其他人可能需要阅读它时，它们提供了解释和理解。

注释：编译器是不执行的，就是自己看或者别人看，人人交互，不是人机交互！

为了方便程序的阅读，Java语言允许程序员在程序中写上一些说明性的文字，用来提高程序的可读性，这些文字性的说明就称为注释。 注释不会出现在字节码文件中，即Java编译器编译时会跳过注释语句。 在Java中根据注释的功能不同，主要分为单行注释、多行注释和文档注释。

Java 多行注释

Java 也支持跨多行的注释。

Java 多行注释以 /* 开始，以 */为止。例如：

/*  这是一个
 *  多行注释 
 */

请注意，Java 不支持嵌套的多行注释，但是，您可以在多行注释中嵌套单行注释。

例如：

/* 嵌套单行注释
   // 单行注释
 */

1. 1. 
      
2. 单行注释：  使用“//”开头，“//”后面的单行内容均为注释。
   
3. 多行注释：   以“/*”开头以“*/”结尾，在“/*”和“*/”之间的内容为注释，我们也可以使用多行注释作为行内注释。但是在使用时要注意，多行注释不能嵌套使用。
   
4. 文档注释：   以“/**”开头以“*/”结尾，注释中包含一些说明性的文字及一些JavaDoc标签(后期写项目时，可以生成项目的API)
   
   1. 
      

/**
 * Welcome类（我是文档注释）
 * @author 赵广陆
 * @version 1.0
 */
public class Welcome {
    //我是单行注释
    public static void main(String[] args/*我是行内注释 */) {
        System.out.println("Hello World!");
    }
    /*
       我是多行注释！
       我是多行注释！
     */
}

3 Java 文档注释

文档注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息，并输出到html文件中。

文档注释，使你更加方便的记录你的程序信息。

Java 文档注释以 /** 开始，以 */结束。例如：

/** 这是一个文档注释 */

/** 这也是一个
    文档注释 */

在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。

之后，你可以包含一个或多个各种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*).

下面是一个类的说明注释的实例：

/**
* 这个类演示了文档注释
* @author 赵广陆
* @version 1.0
*/