java 方法注释规范（不写注释的程序猿）

⾸先我们来解释⼀下什么是程序中的注释，注释就是对程序的解释说明，简单地理解其实就是对代码的解释说明，⽐如我们买⼀件电器，那么基本会附带⼀个说明书来解释电器的使⽤，其实注释在程序中也是这样的作⽤。

理由很简单，在我们实际到公司参与项⽬开发时⼀个项⽬是多⼈协作开发，⼀个⼈写的代码可能需要被整个团队其他⼈所理解或者说是，公司的同事有很⼤可能会在你的代码上继续开发，为了代码的可读性以及为了整体团队的开发效率建议添加注释，第⼆呢也是为了我们⾃⼰⽅便，我们从编码思路上考虑，在我们编码思路通畅时，可以很流畅实现某项功能，为了再次阅读这段代码时还能找回当初编码的思路，因此建议添加注释。

接下来我们来看看主要有哪些注解并且注解的格式是什么？

1、单⾏注释

格式：// 注释信息。

以双斜杠“//”标识，只能注释一行内容，用在注释信息内容少的地方。如图所示：

2、多⾏注释

格式： /* 注释信息 */

包含在“/*”和“*/”之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息（这样也比较美观好看），如图所示：

注：多行注释可以嵌套单行注释，但是不要嵌套多行注释和文档注释。

3、⽂档注释

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

包含在“/**”和“*/”之间，可以注释多行内容，一般会运用在类、方法和变量上面，用来描述其作用。注释后，鼠标放在类和变量上面会自动显示出我们注释的内容，如图所示。

比如java底层，对⼀个类或者⽅法的解释进⾏注释，如图：

（这⾥我们演示的是String这个类）

我们通过注释⼀下⼦就理解了String类应该怎么⽤，如何⽤，所以注释⼀定是要有，并且还要书写规范，⽽且注释也不宜过⻓。这⾥String类的注释很⻓，是因为这是底层的⼀个类，我们需要知道它的原理才能更好地使⽤java为我们提供的基础类来实现我们的代码但是在实际开发中添加注释时不宜过⻓的

• ● ⾸先我们对于⽅法要添加注释，解释此⽅法实现了什么功能，以及⽅法的参数，返回值也要有明确的标注，eg：
• ● 对于⾮常规的写法也要有注释
• ● 对于复杂的逻辑需要注释
• ● 对于公共的⽅法也要添加注释

但是我们现在发现，国内的不管多⼤还是多小的开发公司都对于注释不是那么重视了，就像我们程序员的头发⼀样越来越少，为啥会造成这样的现象呢？

• ● ⾸先就是对于注释的写法不规范！
• ● 注释的质量差，注释并不能让其他开发⼈员清楚，简单，明了地去理解 ！
• ● 由于代码有会根据需求的变动⽽有所改变，也会于此同时增加改变注解的⼯作量，甚⾄有时并不能及时地对代码注释进⾏改进，那么就会出现偏差，维护费劲！

所以我们在⽇后编写代码时⼀定要注意注释的规范以及，及时有效地修改或编写注释，在⽇常开发中就养成⼀个写规范注释的好习惯