Java注释的3种方式（小白必看）

在编写 Java 程序时，除编写代码以外还有一件非常重要的事情要做，就是给程序编写注释。一个没有注释的程序会大大增加错误发生的概率，特别是如果在大型项目中缺失注释，将会导致后期维护举步维艰。

那么什么是注释呢？注释就是用文字去描述某行或若干行代码的作用是什么，这样就可以很方便地帮助我们阅读程序，有效防止隔一段时间后就忘记了某些代码的作用，并且在写注释的过程中，也能帮助我们更好地厘清代码的逻辑。

Java 程序支持以下三种类型的注释：

• 单行注释：以//开头，其后为注释内容，格式为“// 注释内容”。
• 多行注释：以/*开头并以*/结尾，其间为注释内容，格式为“/* 注释内容 */”。
• 文档注释：以/**开头并以*/结尾，其间为注释内容，注释内容包含了 Javadoc 标签，格式为“/**文档注释标签*/”。

我们知道 Java 代码是会被编译的，然而注释却不会被 Java 编译器编译，所以不管你增加了多少注释都不会影响代码的逻辑。也就是说，当编译器遇到//时会忽略该行的文本，当编译器遇到/*时会查找下一个*/并忽略其间所有行的任何文本，当编译器遇到/**时会查找下一个*/并忽略其间所有文本。

1、单行注释

对于单行注释只能在同一行编写注释内容，例如：

public class CommentOneLine {
    public static void main(String args[]) {
        // 这是单行注释，输出“单行注释”
        System.out.println("单行注释");
    }
}

2、多行注释

多行注释能够在多行上编写注释内容，举个简单的例子：

public class CommentMultiLine {
    public static void main(String args[]) {
        /*
         *  这是多行注释
         *  可以分成多行进行注释
         *  输出“多行注释”
         */
         System.out.println("多行注释");
    }
}

3、文档注释

文档注释一般位于类、方法和变量上面，它也支持多行注释，文档注释的内容在后期能通过 Javadoc 工具生成说明文档，文档以 HTML 网页格式文件提供，使我们更加便捷地查看 Java 程序中的相关信息。

Javadoc 支持很多标签，这里我们举个例子：

public class CommentJavadoc {

    /**
    * 文档注释<br>
    * 根据传入的长度和宽度计算长方形面积
    * @param heigth 表示长方形的长度
    * @param width 表示长方形的宽度
    * @return 长方形的面积
    */
    public int area(int heigth, int width) {
        return heigth * width;
    }
}

area 方法用来计算长方形面积，传入的是长方形的长度和宽度，返回的是长方形的面积。

添加如上的注释后我们再执行 javadoc CommentJavadoc.java 命令，如下图所示，就会生成对应的 HTML 页面。


我们用浏览器打开 CommentJavadoc.html 页面就能够看到生成的说明，其中清晰描述了 area 方法的功能和参数，如下图所示。


声明：《Java系列教程》为本站“54笨鸟”官方原创，由国家机构和地方版权局所签发的权威证书所保护。