【精致Java教程】08：注释

现在，我请你想象一下此时的你正沉浸在天马行空的状态啪啪啪的写下了一段华丽丽的代码。但是过了一段时间你发现代码有不足的地方或者需求变了需要重构，也可能你离职了需要把项目交接给别人。如果只有源代码的话未来的你或者别人很难进入到你现在的思路。所以在代码里我们通常需要在某些地方加一些说明，以便未来的自己或他人更好的理解代码。而程序中的注释就是作为说明穿插在代码中但是不对程序产生任何作用，只是给程序员们看的。

Java的注释有三种：

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

单行注释##

单行注释就是注释一行内容，以// 开头直到行末。

System.out.println("祈求代码不出bug要拜谁？"); // 大家好，我是单行注释
System.out.println("雍正，专治八阿哥。"); // 注释的内容不起作用

多行注释##

多行注释也称作块注释，指把多行内容作为注释，以/* 开头直到碰到 */。

/*
大家好，我是块注释
System.out,println("这条输出语句不起作用。");
*/

文档注释##

文档注释比较复杂，这里指介绍部分用法，等学完相关语法再补全。
文档注释和多行注释很像，是把一段内容作为注释。语法是以/** 开头以 */结尾。但是和普通的注释有三个本质的区别：

• 作为说明写在包、域、类、方法的前方，而不是像单行注释和多行注释穿插在代码的任意位置。
• 可以用javadoc工具生成API文档
• 可以添加一些标记

这里只介绍@author 一个标记，其后面跟的是作者名字。
文档注释还有很多标记，而且还能自动生成文档文件。这些等学习了相应语法会再进行介绍。
我们来看一个包含三种注释的示例代码：

/**
 * 我是文档注释，在这里用于对类做相关说明。
 * 这是一个注释的demo。
 * @author xuhongchuan
 */
public class Bug { // 用public修饰的类名和文件名必须一致。
    
    /**
     * 我是文档注释，在这里用于对方法做相关说明。
     * 这是main方法，程序从main方法开始。
     */
    public static void main(String[] args) {
        System.out.println("祈求代码不出bug要拜谁？"); // 我是单行注释。
        System.out.println("雍正，专治八阿哥。"); // 注释的内容不起作用。
        
        /*
        我是块注释。
        System.out,println("这条输出语句不起作用。");
        */
    }

}

运行结果是

我想此时应该对注释有所了解了。最后鼓励大家为代码写注释和文档，不过写这些确实很枯燥，有个笑话叫程序员最讨厌四件事：写注释，写文档，别人不写注释，别人不写文档。那我也说一句，己所不欲勿施于人，对自己写的代码有点责任感。

本文代码下载：百度网盘