@[TOC]

0 写在前面

一段良好的代码应该有注释，这样可以使不同的创作者或者阅读者进行良好的阅读。
与大多数程序设计语言一样，Java 中的注释也不会出现在可执行程序中。因此，可以在源程序中根据需要添加任意多的注释，而不必担心可执行代码会膨胀。

1 格式

在 Java 中，有 3种标记注释的方式。
格式一（单行注释）：// 注释内容
格式二（多行注释）：/* 注释内容 */
格式三（生成文档注释）：/** 注释内容 */

2 演示

2.1 单行注释

最常用的方式：其注释内容从//开始到本行结尾

    //双斜线后面加上注释内容

2.2 多行注释

一般用在单行放不开了，需要写在多行时使用。

    /*
        注释内容
        注释内容
        注释内容
        注释内容
    */

2.3 生成文档注释

可以用来自动地生成文档，一般用在方法或类上方，进行方法说明或者类说明。

    /**
    *    注释内容
    *    注释内容
    *    注释内容
    *    注释内容
    */

3 写在最后

通过注释提高Java 源程序 代码的可读性；使得Java程序条理清晰，易于区分代码行与注释行。 另外通常在程序开头加入作者，时间，版本，要实现的功能等内容注释，方便后来的维护以及程序员的交流。希望所有人都有随手写注释的良好习惯。
但也希望注释精简干练，不然就会又臭又长。