注解注释简介

最新推荐文章于 2024-10-29 10:08:05 发布

大胡在进步

最新推荐文章于 2024-10-29 10:08:05 发布

阅读量569

点赞数

分类专栏： java基础知识（要点、坑点）总结文章标签： java 分布式实时大数据

版权

3 篇文章

订阅专栏

本文详细介绍了Java编程中不同类型的注释，包括行注释、块注释和文档注释的使用，以及类注释、方法注释和变量注释的规范。强调了注释对于代码可读性和维护性的重要性，并分享了如何编写清晰、有用的注释。同时，文中还提及了程序员对于注释的普遍态度，提示良好的注释习惯对于团队协作的价值。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

注解注释是用来解释说明包或者类或者方法甚至某行代码的用途的解释性文字，也可以包含一些基本信息，如作者、时间、参数、功能等。

1.注释方式

标记为 // , 其注释内容从 / / 开始到本行结尾,为比较常用的注释方式快捷键为： ctrl + /

标记为 /* 代码 */，范围为符号之间的区域，不能互相包含，不然只能识别第一个结束符号，

标记为 /** 代码 */，开始符号里面多个 *，此注释除了能注释代码快之外，还能结合javadoc生成文档

类注释必须放在类前（import 和类名之间），主要包含类功能解释、作者、时间、版本等

/**
*@describe    时间工具类
*@author      dahu
*@date        2021/11/23 15:43:20
*@version     1.0.1
*/

方法的注释必须放在方法紧前面，主要包含方法的功能、入参、出参等，里面内容可以自定义

/**
*@describe    返回与上一笔的差价
*@param       current_order_id 当前订单编号
*@return      price  double类价格
*/

一般用来注释静态变量，常用在静态变量类或者全局变量里面

// 一年天数定义
public static final int YEAR_NUMBER_DAYS = 365

个性化使用，可以解释某行代码为什么这么写，可以解释为啥调用这个方法，或者提醒遗留坑点等等，这个自由发挥

有个段子：程序员最烦的两件事：自己写注释，别人不写注释。虽然写注释很枯燥，但是这有益于自己自己思路的总结，方便自己和后面维护的人快速了解，有时在某个时刻我们觉得很简单的东西，但是时间已过，就容易忘记。同时也是为了防止后人骂娘吧，给自己积点德。