红茶的个人站点

  • 首页
  • 专栏
  • 开发工具
  • 其它
  • 隐私政策
Awalon
Talk is cheap,show me the code.
  1. 首页
  2. 开发工具
  3. 正文

每天一个 Idea 小技巧:Java Doc

2025年7月11日 10点热度 0人点赞 0条评论

Java 代码中会使用一些特殊符号在注释中标记代码信息:

/**
 * 获取指定性别的用户列表
 * @param sex 性别
 * @return 用户列表
 */
List<User> getUsers(User.Sex sex);

这些注释别称作 Java Doc,它规定了一套固定用途的特殊标记,比如@param表示方法形参等。

但这些特殊标记很有限,有时候不能满足你的需要,或者其他第三方工具会生成一些自定义的标记:

/**
* @author 70748
* @description 针对表【user(用户表)】的数据库操作Service
* @createDate 2025-07-09 14:10:30
*/
public interface UserService extends IService<User> {

这是 MybatisPlusX 插件生成的注释,只有@author是标准标记,此时 Idea 会对标记进行检查,提示警告信息。更糟糕的是,如果通过 Idea 的内置 git 工具提交代码,同样会显示相关的警告信息,并且需要你二次确认才能提交代码。

解决方式很简单:

image-20250711105823435

将需要使用的非标准标记通过快速修复(Alt+Enter)添加为自定义标记即可。

当然这样做只对当前项目有效,对常用的自定义标记,最好在 Idea 的默认设置中进行添加,这样新项目也可以正确识别这些自定义标记。

image-20250711110057120

image-20250711110132170

image-20250711110152998

The End.

参考资料

  • IDEA 一劳永逸的解决 Wrong tag ‘Author:‘ Wrong tag ‘Date:‘ Wrong tag ‘Description:‘ 警告信息_wrong tag 'date-CSDN博客

本作品采用 知识共享署名 4.0 国际许可协议 进行许可
标签: IDEA
最后更新:2025年7月11日

魔芋红茶

加一点PHP,加一点Go,加一点Python......

点赞
< 上一篇
下一篇 >

文章评论

razz evil exclaim smile redface biggrin eek confused idea lol mad twisted rolleyes wink cool arrow neutral cry mrgreen drooling persevering
取消回复

COPYRIGHT © 2021 icexmoon.cn. ALL RIGHTS RESERVED.
本网站由提供CDN加速/云存储服务

Theme Kratos Made By Seaton Jiang

宁ICP备2021001508号

宁公网安备64040202000141号