0


【IDEA】解决@param XX tag description is missing问题

前言

在开发Java项目的过程中,我们常常会使用到IntelliJ IDEA这款强大的集成开发环境。IDEA不仅提供了丰富的代码补全、调试和版本控制等功能,还内置了一套严格的代码审查机制,帮助我们提高代码质量。

然而,在享受这些便利的同时,有时我们也会遇到一些困扰。比如,当我们使用@param标签来注解方法的参数时,IDEA可能会提示“param XX tag description is missing”的错误。这可能是由于我们在编写文档注释时,忘记了为@param标签添加描述信息。

这样的提示虽然有助于我们发现并修正可能存在的问题,但对于一些不需要详细描述参数的简单场景来说,可能会显得有些繁琐。因此,本文将详细介绍如何解决IDEA提示“param XX tag description is missing”问题,以满足不同开发者的需求。

正题

1.1 原因分析

一张图告诉你为什么会提示这个错误

1.2 解决方法

所以这个问题的解决方法很简单,时序对注释加上描述就可以了


但是!!!(干掉问题)

事情是这样的,老板最近安排我做项目的重构,因为写的是底层的一些代码,老板就要求尽量简单,不要加那些注释。但是我每次提交代码的时候,idea都会提示我有一些错误,处于严谨,我每次都要看看是哪些问题,毕竟底层代码必须规范,每次都是这些注释的问题。因此,对此这些有特殊需求的同学,接下来我将教大家如何干掉问题,即让idea不审查这种错误。

1.1 到设置中将注释缺陷检查关掉即可

路径:File | Settings | Editor | Inspections

补充

代码检查的功能是非常实用的,建议大家每次代码编写完都F2检查一下代码有没有错误,关掉检查只是针对一些特殊的需求场景,将来下跟大家分享一下如何解决类似的问题

点击窗口右上角的错误提示,进详情右击错误提示即可出现复制错误描述,复制后去前边的设置页面,结合错误等级(例如黄色的Warning)和错误出现的地方(例如Java)一般就可以定位到这个检查,对应关掉即可。

标签: intellij-idea java ide

本文转载自: https://blog.csdn.net/wenxuankeji/article/details/134982034
版权归原作者 李少兄 所有, 如有侵权,请联系我们删除。

“【IDEA】解决@param XX tag description is missing问题”的评论:

还没有评论