Java三大注释

首先，我们来说说什么是注释。

简单点说，注释就是注解、解释、旁白、概述、段落大意...，就是对某一段代码的一个概括性的说明。

了解了什么是注释，我们再来说说为什么要写注释。或者叫注释的重要性。

先来看看专业的说法：代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。

解读一下，软件开发是一个团队合作的事情，你写的代码不光你自己要看，团队中的其他成员也要看并拿来使用，如果没有任何注释，别人看你的代码就会很费劲，很浪费时间。比如，你写了很多个方法，现在别人要调用其中的某个方法，但是没有任何注释，他根本就不知道要调哪个，只能一个个去看方法的具体实现，看看这个方法的功能是不是自己需要的，运气好第一个就是，运气不好的话，可能最后一个方法才是他需要的。这样开发效率太慢。而且，当你自己写的类和方法很多的时候，你自己可能都会记混，想要维护修改也很费事。

明白了注释的重要性之后，再具体来看注释的形式。

Java中注释有三种，分别是单行注释、多行注释、文档注释。

1、单行注释：

    语法格式：//注释信息

   说明：注释内容从两个正斜线开始一直到本行结束

2、多行注释

   语法格式：/*注释信息*/

   说明：/*和*/之间的内容，无论多少行，都是注释内容

3、文档注释

   语法格式：/**注释信息*/

   说明：与多行注释类似，但是文档注释可以生成帮助文档

需要添加注释的条件

   基本注释（必须加）：

        a.类（接口）的注释

        b.构造器的注释

        c.方法的注释

        d.全局变量的注释

        e.字段/属性的注释

        说明：简单的代码做简单的注释，一般不大于10个字，另外，持久化对象和值对象的getter和setter方法不需要加注释

   特殊注释（必须加）：

        a.典型算法必须有注释

        b.在代码不明晰出必须有注释

        c.在代码修改处加上修改标识的注释

        d.在循环和逻辑分支组成的代码中加注释

        e.为他人提供的接口必须加详细注释

书写注释的原则

    1、注释形式统一

    在整个程序中，使用具有一致的标点和结构的样式来构造注释。如果在其他项目中发现他们的注释规范与规范文档不同，按照规范文档修改注释，不要试图在既成的规范系统中引入新的规范。

    2、注释内容准确简洁

    注释内容要简单、明了、含义准确，防止注释的多义性。错误的注释比不写注释更可怕。

再说个值得注意的情况，多行注释与文档注释之间不能相互嵌套，因为他们的结束符号相同，所以默认的会去寻找最近的结束符号。

/*多行注释

/**

文档注释

*/

*/

上面的情况，本来是多行注释中有个文档注释，但是默认的会把标红的两个进行配对，就会导致两种注释交叉在一起，而且，文档注释的开头变成了多行注释的注释内容，最后结果就是最后一个结束符号没有对应的开始符号。