【注】意【释】怀

前言

Q：我刚刚看见注释了！

A：注释是哪一位？

Q：不是哪一位，是又在类中又在方法中的注释！

A：@RequestMapping

Q：不是纯英文，是带/和*。

A：@RequestMapping("/test/*")

Q：不是，他是前面是/和*，后面是字符串

A：@RequestMapping("/*/test")

Q：注释啊！代码有没有看过，就是那种文字很长的那种，前面带/和*的注释，明白吗？

注释

方式

单行注释

主要在属性字段或者代码片段上使用，不会被jvm所执行。

// 单行注释

多行注释

主要在属性字段或者代码片段上使用，不会被jvm所执行。

/*
  多行注释
*/

文档注释

主要在类和方法上使用，是java所特有的，会被javadoc执行，生成说明文档

/**
* 文档注释
*
*/

后语

在实际项目开发中，总是会遇到很多不写注释的情况，项目的“渣男”前任已经离职，作为”接盘侠“的你，在没有注释的时候，看着项目中一行行代码是不是有种代码的心思你别猜，嘴里已经在嘀嘀咕咕的“感谢”前任了，过了一段时间在你接到需求要进行改动原来的代码时候，却惊喜的发现有注释的时候，心里暗暗感谢前任，然后根据注释修改好代码，测试时候结果却跟预期不一样，带着问号脸盘了一下原来代码的逻辑，发现代码逻辑与注释不一致。最后骂骂咧咧的修改原本的注释，嘴里继续嘀嘀咕咕的“感谢”前任，这时候的你会不会感慨一句，写注释更要及时更新注释。