3.2 Java注释

“二哥，Java 中的注释好像真没什么可讲的，我已经提前预习了，不过是单行注释，多行注释，还有文档注释。”三妹的脸上泛着甜甜的笑容，她竟然提前预习了接下来要学习的知识，有一种“士别三日，当刮目相看”的感觉。

“注释的种类确实不多，但还是挺有意思的，且听哥来给你说道说道。”

01、单行注释

单行注释通常用于解释方法内某单行代码的作用。

public void method() {
    int age = 18; // age 用于表示年龄
}

但如果写在行尾的话，其实是不符合阿里巴巴的开发规约的。

正确的单行注释如上图中所说，在被注释语句上方另起一行，使用 // 注释。

public void method() {
    // age 用于表示年龄
    int age = 18;
}

02、多行注释

多行注释使用的频率其实并不高，通常用于解释一段代码的作用。

/*
age 用于表示年纪
name 用于表示姓名
*/
int age = 18;
String name = "沉默王二";

以 /* 开始，以 */ 结束，但不如用多个 // 来得痛快，因为 * 和 / 不在一起，敲起来麻烦。

// age 用于表示年纪
// name 用于表示姓名
int age = 18;
String name = "沉默王二";

03、文档注释

文档注释可用在三个地方，类、字段和方法，用来解释它们是干嘛的。

/**
 * 微信搜索「沉默王二」，回复 Java
 */
public class Demo {
    /**
     * 姓名
     */
    private int age;

    /**
     * main 方法作为程序的入口
     *
     * @param args 参数
     */
    public static void main(String[] args) {

    }
}

PS：在 Intellij IDEA 中，按下 /** 后敲下回车键就可以自动添加文档注释的格式，*/ 是自动补全的。

接下来，我们来看看如何通过 javadoc 命令生成代码文档。

第一步，在该类文件上右键，找到「Open in Terminal」 可以打开命令行窗口。

第二步，执行 javadoc 命令 javadoc Demo.java -encoding utf-8。-encoding utf-8 可以保证中文不发生乱码。