java注释怎么写_java的注释应该这样写

学习过java的同学，应该都知道java中存在着三种注释，单行注释、多行注释、文本注释。但是，有很多人并不清楚，为什么要写注释，怎么写注释。导致有很多人，开发的时候，并没有写注释，或者写的注释存在着各种各样的问题

第一，我们为什么要写注释？

回想一下，当我们刚开始学习java的时候，是不是会经常翻阅java api手册。这个手册，其实就是通过javadoc工具，根据java源代码中的文档注释自动生成的。所以写好JAVA文档，是可以帮助我们自动生成api文档的。这个api文档，不管是对内部使用或者对外提供，都是非常有用的。

在想一下，当我们接手一个新项目的时候。你不仅是需要查看相应的api文档，你还需要深入了解一下每个方法内部的逻辑，具体实现。这时候，如果没有注释。可能你就要花费大量的时间，去思考代码实现或者找原作者沟通了。但有时，就算你花费了大量时间，可能还是不懂或者连原作者自己也看不懂当时自己写的代码了。所以，注释是一个很好的东西，他可以帮我们理解程序中的每一行代码在做什么，以及为什么这么做。

注释当然还有很多其它的作用。但就是以上两点，已经足够让我们认真写好我们项目当中的注释了。

第二，我们应该怎么写好注释？

我觉得每一个项目团队，或者程序员个人，都应该有自己的一套完整注释模板。这个在idea或者eclipse等项目管理工具中，都有提供模板功能的。我们可以通过这个模板功能，来管理自己的注释。

一般我们需要准备以下几种模板。

1、文件注释模板。

文件注释写在文件的最上方，用于介绍该文件的信息。一般包含文件作者、文件创建时间、文件描述、文件版本号等信息

2、接口或类注释模板

接口或类注释，放在接口或类的声明上，用于介绍该类或者接口的信息。一般包含作者、创建时间、文件描述等信息。该注释与文件注释有些类似

3、方法注释模板

方法注释，放在方法上面，用于介绍方法的信息。一般包含方法的入参、反参、抛出异常、作者、创建时间，方法描述等信息

有了模板之后，我们可以通过模板，在类、接口、方法上，更加方便地添加我们的注释了。

另外，我们比较常用的，还有属性注释，方法内部的注释

属性注释。属性注释写在java对象的属性声明上，用于描述对象属性的含义。

方法内的注释。方法内部注释，写在方法内部，用于描述接下来一行或者一段代码的业务逻辑或者执行步骤。

在我们写java注释的时候，还有有一个非常重要的概念，就是doc标签。这些标签是由java官方提供的。用于描述类、方法等的基本属性，标签以@开始。一般常用的标签有@author、@date、@since、@param、@throw、@return等。

在编写注释模板，或者我们手动书写注释的时候，应该尽量按照javadoc规范来。

好的代码注释，能使我们代码的维护成本大大降低。减少一些不必要的沟通成本，也在另一方面提升了我们的开发效率

坏的注释，有时会让你觉得莫名其妙。代码的可读性和维护性，大大降低。

而且随着时间的推移，注释会对项目的影响会越来越大。所以，我们应当在项目的开始阶段，就有意识地完善我们的代码注释了。

java中的注释，要讲的内容还是有很多的。如果大家有什么不清楚的，想了解的，都欢迎在下面评论区留言。我会一一回复的