IDEA设置方法参数(@param/@return)缺失/漏写的检查提示

已于 2023-03-01 10:20:48 修改
阅读量1.2w 收藏 6
点赞数 2
分类专栏： IDEA 文章标签： idea intellij idea java
于 2021-02-05 11:28:59 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_38209121/article/details/113685469
版权
本文介绍了在IntelliJ IDEA中如何设置Javadoc检查规则，以确保方法注释的完整性和规范性。通过打开设置，找到Javadoc的Inspections选项，启用'Declaration has Javadoc problems'检查，可以实现在漏写参数或返回值注释时出现明显的提示，提高代码审查效率。这种方法尤其适合团队开发，但仅检查打开的文件，不适用于全局扫描。
摘要由CSDN通过智能技术生成

文章目录

老版本

开发团队要求方法注释需要按照以下规则书写：
方法名 参数 返回值三样缺一不可
在这里插入图片描述
在之前没有设置注释检查时
是不会像下图这样有小红线提示的
那在开发过程中如果产生漏写(错写和多写均有提示 这里不赘述 这里只涉及漏写的检查)的情况 只能靠肉眼去观察 这样的效率和可靠程度不可观
在这里插入图片描述
下图是提示的内容 可以清晰的看到
缺少了关于’age’和’name’的’@param’标签
缺少了’@return’的标签
这样就达到了 在漏写的情况下很直观的发现问题
在这里插入图片描述
设置方法：
打开IDEA->File->Settings->搜索javadoc->Inspections->Declaration has Javadoc problems
（仔细看图 不好用语言描述）
在这里插入图片描述
这样设置过后 就会在漏写参数或返回值的时候出现提示(小红线)

补充说明上图中的’另一个方面’
上图中蓝色圈圈围住的设置 是用来设置javadoc检查的域(可以设置为只检查某个包下面的代码格式)
直接上图说明:
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
命名自定义 自己明白就行 这里为123(不推荐这样的命名 不直观 仅为举例说明)
在这里插入图片描述
会出现如下图所示 点击OK
在这里插入图片描述
设置我们配置好的检查域(选择自己的命名)
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
大功告成！

Tips:
对团队开发来说 还是个不错的推荐 特别对于那些对代码有一定要求的团队来说 挺不错的
（但这种检查设置只能检查打开的文件 它不会去自动扫描所有的文件去检查）

下一篇会说明如何屏蔽不需要的检查
在这里插入图片描述

2022.1版本

在这里插入图片描述

一个编程界的小学生
关注
  • 2
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
IDEA设置类注释和方法注释
Louka的专栏
07-18 8274
注意如果idea版本在2020.3以下，会在Expression获取时缺失methodParameterTypes()方法，得到的参数类型会为null。description不勾选Skipifdefined时自动补全注释后光标停留在注释第一行，填写方法描述，默认用Tab键自动补全代码，如果想用Enter自动补全代码，点击右边的ExpandWith，换成Enter即可。应用后新建文件时，会自动添加作者，创建时间，描述的注释。接口被调用处，鼠标移到方法上，自动显示注释描述的信息。......
@RequestParam出现的数据丢失
DEVZYH
05-13 1188
问题复现 在 Sping MVC 中我们经常使用 @RequestParam 注解来获取请求传入的参数。 正常情况下可以正常使用不会产生问题，当传入的参数过大时就会出现参数不全的情况。 下有一段控制器代码如下： @RestController public class ApiController{ @PostMapping("in") public ResponseMessage inbound(@RequestParam Map params) { System.out.println
【IDEA】解决@param XX tag description is missing问题
wenxuankeji的博客
12-15 2788
解决@param XX tag description is missing问题，以及类似问题的解决方案！
idea中 参数没有描述报错 @param XX tag description is missing错误，去除黄色警告
Lewis的博客
11-17 7946
idea中 参数没有描述报错 @param XX tag description is missing错误，去除黄色警告 问题： 最近在使用idea开发工具，在方法备注中参数没有描述报错就会报一些黄色警告： @param XX tag description is missing，下面展示去除黄色警告的方法 解决方法： File–setting–inspections–搜索javadoc 找到Declaration has Javadoc problems 去勾。 ...
ideal——标签丢失
yhhhhhh_的博客
03-08 663
ideal项目中的模块右下角的小蓝块没了，或者是包下的类出现了.java后缀
解决idea自动生成注释时无法获取Param及return的问题_idea methodparameters() 和 methodreturntype() 不生效
最新发布
2401_83947398的博客
04-16 648
最近很多小伙伴找我要Linux学习资料，于是我翻箱倒柜，整理了一些优质资源，涵盖视频、电子书、PPT等共享给大家！
mybatis-demo9-方法多参数@Param.zip
08-05
在MyBatis中，`@Param`注解是用来处理方法中多个参数的情况，尤其是在编写自定义的Mapper接口时。这个注解允许我们为每个参数指定一个唯一的名称，以便在SQL语句中引用它们。下面我们将深入探讨`@Param`的使用、作用...
Idea自定义方法注释模板的教程详解(去param括号、return全类名)
08-18
本文将详细介绍Idea自定义方法注释模板的创建和配置过程，包括模板的创建、参数设置、return类型设置等。 一、创建自定义方法模板 要创建自定义方法模板，需要按照以下步骤进行： 1. 打开 IDEA，点击File >> ...
mybatis多个接口参数的注解使用方式（@Param)
08-26
MyBatis 多个接口参数的注解使用方式（@Param） 在 MyBatis 中，使用 @Param 注解可以实现多个接口参数的传递，这可以解决在实际开发中遇到的多个参数传递问题。本文将详细介绍 MyBatis 中多个接口参数的注解使用...
idea注解参数换行时间日期格式设置方法
08-19
Idea注解参数换行时间日期格式设置方法 idea注解参数换行时间日期格式设置方法是指在IntelliJ IDEA中对注解参数的换行时间日期格式进行设置的方法。在本文中，我们将通过实例代码对idea注解参数换行时间日期格式...
Mybatis使用@param注解四种情况解析
09-07
在Mybatis框架中，`@Param`注解是一个非常重要的元素，它用于给方法参数命名，使得Mybatis能够识别并正确地将Java方法的参数值映射到SQL语句中的占位符。下面我们将详细探讨`@Param`注解在四种不同情况下的使用和...
Idea设置方法注释模版param和return不生效问题
Montainer_Climb的博客
01-22 814
按照普通方法在Template Text里以/**开头，param和return会无法取到方法内部的参数。可设置为*开头，其他的和网上一致。
IDEA 方法注释，params表达式，return 表达式
sinat_34842630的博客
11-20 2058
对于无参，无返回值方法都适用 打开，settings配置->Live Templates，新建group， Template text: * * @Description: * @Author: Ryan * @Date: $date$ $time$ $params$ $returns$ **/ param表达式为： groovyScript(...
Idea设置方法注释 param return自动填充
蓝影灵的博客
03-02 450
快捷键：/*+ au+enter。
idea 自动注释 param return
核桃的博客——JavaWeb技术分享
06-24 5874
类注释很简单，网上教程也很多，在此仅截图记录下 #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end /** * @description: ${description} * * @author: hetao * * @create: ${YEAR}-${MONTH}-${DAY...
解决idea添加方法注释时，@Param为null的问题，以及无返回值时显示@Return的问题
a929549977的博客
05-14 6055
intelij Idea生成方法注释,解决参数为空以及返回值错误的问题
【IntelliJ IDEA】〖优化〗IDEA方法注释模板，优化@param和@return的返回值，解决‘@param xxx‘ tag description is missing参数报错问题
Need not to know
01-10 1万+
〖优化〗IDEA方法注释模板，优化@param和@return的返回值，解决’@param xxx’ tag description is missing参数报错问题 IDEA方法注释模板 优化@param和@return的返回值 解决’@param xxx’ tag description is missing参数报错问题 IDEA方法注释模板     1.点击File→Settings...，然后点击Editor→Live Templates。 &nbsp
常见编程软件注释 @brief @param @return
热门推荐
qq_40305944的博客
03-27 10万+
/** * @brief @param @return @author @date @version是代码书写的一种规范 * @brief ：简介，简单介绍函数作用 * @param ：介绍函数参数 * @return：函数返回类型说明 * @exception NSException 可能抛出的异常. * @author zhangsan： 作者 * @date 2011-07-27 22:30:00 ：时间 * @version 1.0 ：版本 * @property ...
idea java return 报错
qq_27878777的博客
01-11 662
package com.gem.student.dao.impl; import com.gem.student.dao.UserDao; import com.gem.student.entity.User; import com.gem.student.template.JdbcTemplate; import java.sql.PreparedStatement; import java.sql.ResultSet; public class UserDAOImpl implements Use
/** * @param h* @param* @return /
09-14
根据所提供的引用内容，这是一个函数头部的注释示例。在这个示例中，`@param`用于指定函数的输入参数，`@return`用于指定函数的返回值类型。在这个例子中，`@param`后面跟着的是参数的类型和名称，`@return`后面没有给出返回值的具体描述。如果你想添加一个新函数的函数头部注释，你可以按照这个示例来编写你自己的注释。 根据你的问题，你想要知道如何在函数头部注释中使用`@param`和`@return`。对于`@param`，你需要在`@param`后面指定参数的类型和名称。对于`@return`，你需要指定函数的返回值类型。在你的问题中，你提到了`@param h`和`@param`，但是没有给出具体的参数类型和名称。对于`@return`，你只提到了`@return`，但是没有给出具体的返回值类型。 因此，为了回答你的问题，在函数头部注释中使用`@param`和`@return`，你需要按照示例提供参数的类型和名称，以及指定函数的返回值类型。在这个特定的问题中，由于没有提供具体的参数和返回值的信息，我无法提供更详细的回答。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值