Java注释详解（3种写法）

所谓注释，简单来说就是程序中的一段解释和说明的文字，主要被用来解释程序中某段代码、某个类、某个方法以及方法中各参数、返回值等元素的作用或用途。

注释的内容在程序编译时会被编译器忽略，不会对程序的运行结果产生任何影响，因此我们可以根据需要在程序中添加任意多的注释，而不必担心程序过度膨胀。

注释是程序源代码中一个十分重要的部分，对于一份规范的程序源代码而言，注释的比例应该占到源代码的三分之一以上。我们在编写程序时，尤其是在编写一些复杂的程序时，通常都需要在程序中加入一些注释，这样可以有效地的增加程序代码的可读性，有利于程序的调试、修改以及团队成员之间的交流。

此外，在实际的开发过程中，注释还有一个十分常见且实用的用法。那就是当我们发现程序中某段代码暂时不需要了，可以使用注释的方式将其包裹起来，这样这段代码就不会被编译了。如果我们想要再次使用这段代码，只需要将注释取消掉即可。

为自己编写的代码添加注释是每一个开发人员都必须具备的良好的编程习惯，也是大多数企业对开发人员的基本要求之一。

几乎所有的编程语言都提供了添加注释的方法，Java 语言也不例外。在 Java 中，根据功能和用途的不同，注释主要分为以下 3 种。

单行注释
多行注释
文档注释

下面，我们就分别对 Java 中的这 3 种注释进行讲解。

1. 单行注释

在 Java 中，单行注释以双斜线//为标识，是一种只能注释一行内容的注释形式。当我们想要注释掉某一行内容或代码时，只需要将双斜线//放在它之前即可。

示例

下面我们就通过一个简单的实例，来演示下单行注释的用法。

新建一个名为 commentDemo 的 Java 项目，并在其 src 目录下创建一个名为 TestSingleLineComment 的 Java 类，代码如下。

复制纯文本复制

public class TestSingleLineComment {
    public static void main(String[] args) {
        //这是一个单行注释
        System.out.println("    *");
        // System.out.println("C语言中文网：c.biancheng.net");
        System.out.println("   ***");
        System.out.println("  *****");
        System.out.println(" *******");
        System.out.println("*********");
    }
}

public class TestSingleLineComment {
    public static void main(String[] args) {
        //这是一个单行注释
        System.out.println("    *");
        // System.out.println("C语言中文网：c.biancheng.net");
        System.out.println("   ***");
        System.out.println("  *****");
        System.out.println(" *******");
        System.out.println("*********");
    }
}

运行这个 Java 程序，控制台输出如下。

    *
   ***
  *****
 *******
*********

2. 多行注释

当 Java 程序代码中需要注释的内容不止一行时，我们可以将需要注释的内容放在/*和*/之间，这种注释的方式就是 Java 中的多行注释。其中，/*表示注释的开始，而*/则表示注释结束。

示例

下面我们就通过一个简单的实例，来演示下多行注释的用法。

在 Java 项目 commentDemo 的 src 目录下，新建一个名为 TestMultilineComment 的 Java 类，代码如下。

复制纯文本复制

public class TestMultilineComment {
    /*
    这是一个多行注释
    多行注释可以注释多行内容
    123456789
    Java是世界上最好的编程语言！
     */
    public static void main(String[] args) {
        System.out.println("多行注释");
    }
}

public class TestMultilineComment {
    /*
    这是一个多行注释
    多行注释可以注释多行内容
    123456789
    Java是世界上最好的编程语言！
     */
    public static void main(String[] args) {
        System.out.println("多行注释");
    }
}

运行这个 Java 程序，控制台输出如下。

多行注释

3. 文档注释

除了单行注释和多行注释外，Java 语言还提供了一种特有的、功能更强大的注释形式：文档注释。

文档注释以/**开始，以 */结束，使用这种使用这种方式注释的内容可以被 JDK 提供的javadoc工具解析，生成一套程序说明文档。

示例

在 Java 项目 commentDemo 的 src 目录下，新建一个名为 TestDocComment的 Java 类，代码如下。

复制纯文本复制

/**
* 这是一个文档注释
*
* @author C语言中文网 c.biancheng.net
* @version 1.0
*/
public class TestDocComment {
 
    public static void main(String[] args) {
        System.out.println("文档注释");
    }
}

/**
* 这是一个文档注释
*
* @author C语言中文网 c.biancheng.net
* @version 1.0
*/
public class TestDocComment {

    public static void main(String[] args) {
        System.out.println("文档注释");
    }
}

运行这个 Java 程序，控制台输出如下。

文档注释

Java注释详解（3种写法）

1. 单行注释

示例

2. 多行注释

示例

3. 文档注释

示例

相关文章