一起养成写作习惯！这是我参与「掘金日新计划 · 4 月更文挑战」的第8天，点击查看活动详情。
哈喽，各位小伙伴们好，我是喵手。
今天我要给大家分享一些自己日常学习到的一些知识点，并以文字的形式跟大家一起交流学习，互相学习，才能成长的更快，对吧。
我是一名java开发，所以日常接触到最多的就是java啦，所以我趁自己有空，就来好好回忆，把自己学到的会的，进行输出，不图什么有回报，只想能帮助到更多的小伙伴，就好。
小伙伴们在批阅的过程中，如果觉得文章不错，欢迎点赞、收藏、关注哦。三连即是对喵手我创作道路上最好的鼓励与支持！
一、前言
经过前几期的java基础内容教学，还记得我们都讲了那些知识点嘛？回忆回忆，动动大脑，java数据类型有哪些？什么int、double、char等，那java运算符可分哪几类？什么算数运算符、位运算啊等。对不对，如果真不记得，不碍事，我前几期的教学内容还在，希望你们能去温故一遍。不能学了后边的丢了前边的。
那么今天，我给大家讲点什么呢？奥有了，java文档注释。大家想学么？
说起java注释，这可是在实战开发中必不可少的，虽然经常吐槽别人开发不写注释，但是轮到自己的时候，自己也是很厌烦写注释，因为自己肯定是能理解这段代码或者逻辑块是具体干啥用的，但是注释还是有必要写一写的，这一来为了方便自己日后复盘订正bug，二来方便日后运维管理，如果说一大片都没有注释说明，我肯定是不会看的更别说别人了。
所以说起这java注释，这一块还是很重要很关键的。
二、java注释
什么是java注释？
说起java注释，那肯定很多小伙伴都会有疑问，听你讲的这么神乎其神，那这究竟是何方神圣呢？
java注释是代码中不可或缺的一部分，它不仅用来表述代码功能说明，还用来说明代码注事事项等。注释语句是会被编译的，但是不会执行。
所以大胆的写起来吧啊，写的越多越好？非也，把重点关键信息写上注释就好，比如这个函数是干啥用的，函数的入参说明一下，函数的返回值说明一下以及整体函数的功能等。基本就记录这些就好，其他的比如一行写一句注释，那真是有点太麻烦了，这是不需要的。
三、注释分类
想必大家都注释都有了一个基本的认识，那么注释有几种写法呢？这问题问的，就很有水平，注释还真有分类，它共分为三类，分别为单行注释、多行注释和文档注释。
接下来我会给大家意义讲解的，对这三种注释有个完整的介绍及实例演示，让大家能看完我写的文章就记住了这些注释都是干嘛用的。毕竟不想日后不写注释被人说，这就不好了。
1、单行注释
顾名思义，单行，就是对一行进行注释，可以是描述注释也可以是代码注释，若是多行的话，那就每一行都加" // "标识即可。只要你需要注释的地方，在最前面加上" // "，那这行就被注释掉了，在执行的时候就会跳过。
比如我如下演示，分别是单行注释，和多行注释；仅供参考：
//喜欢的话，就点个赞叭！
//这是多行注释。
//你看。
//三行情诗。
int num1 , num2;
num1 = 80;
num2 = 59;
// 如果 num1 >= 80 成立，则输出优秀，否则良好
String str1 = (num1 >= 60) ? "优秀" : "良好";
2、多行注释
那么我有很多内容需要注释，那都得加" // "标识，岂不是太麻烦了，那会不会一次性就能多行注释的方式呢？那就是多行注释法啦，虽然单行注释也可以实现，但是多行注释方式更为方便，它只需要把你需要注释的内容用“ /* ”和“ */ ”包含就行了。
说了这么多，但是多行注释具体怎么使用呢？这个你们先别急嘛，还有一件事，需要大家注意一下，就是使用多行注释就不能再嵌套使用多行注释，但是可以嵌套使用单行注释哦。
如下我就来使用一下多行注释吧。仅供参考：
/*
sum = num2 + num3
然后将sum返回即可。
*/
多行注释嵌套单行注释用法：仅供参考：
/*
sum = num2 + num3
然后将sum返回即可。
//这是单行注释哦
*/
看上去是不是比多个单行注释要方便多了。
3、文档注释
以上我们是学习了单行注释跟多行注释，那还剩一个文档注释没有介绍，如果你能消化的掉，那就再学习一下文档注释的使用吧，相信学完这三种注释，你敲代码就再也不会被骂了。
那什么是文档注释呢？
说起文档注释呢，顾名思义，文档，肯定也是复数级别的注释啦。其语法是注释内容包含在“ /** ” 和 “ */ ”之间，那它跟多行注释有啥区别呢？其实也没多大区别，为了代码优雅吧。在方法上，函数上，类上，都会加文档注释法，比如如下这个：
基本都是使用文档注释来说明其作用，功能等。比如这个方法这个工具类具体是用于干啥的，还有一般会定义创建者，创建时间等。
其次，嵌套问题也是需要注意呢。使用文档注释能嵌套使用单行注释，但不能嵌套多行注释跟文档注释。还有就是约定俗成的一般首行和尾行不写注释信息，希望大家日常也要养成习惯，而不是想怎么注释就怎么注释，市面上都是有一套现成的注释规范。
比如如下实际的文档注释法：
1、注释类上：怎么写？
/**
* md5工具类
*
* @Author haha
* @Date 2022-03-29 13:00
*/
public class MD5Utils {
}
2、注释方法上，又怎么写?
/**
* 审核记录查询
*
* @param applyId 申请人id
* @param declareTag 流程开放标识
*/
List<DFHistoryListVo> getHistoryList(String declareTag, String applyId);
3、文档注释嵌套单行注释，这不会了呀？
/**
* 审核记录查询
*
* @param applyId 申请人id
* @param declareTag 流程开放标识
*
* //用于单行注释
*/
其实说能嵌套使用，没有会与不会，都是代码上上手使用一下。如果不支持会有报错的，这个大家大胆踊跃尝试即可。
... ...
好啦，今天的教学内容到这里就要即将结束啦，如果对文中的任何知识点有疑问，欢迎评论区评论留言呀，我看见都会一一解答的。
四、结尾
教学是结束了，但是有些话不知我但讲不当讲，啊哈哈， 可我还是想说给你们听听。如下是我很喜欢的一句话，我打算送给你们，希望我们都能变得更好更优秀。
学习不分先后，知识不分多少；事无巨细，当以虚心求教；三人行，必有我师焉！！！
wished for you successed ！！！
----------------------------------------------------
⭐️若喜欢我，就请关注我叭。
⭐️若对您有用，就请点赞叭。
⭐️若有疑问，就请评论留言告诉我叭。
----------------------------------------------------
