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 工具提交代码，同样会显示相关的警告信息，并且需要你二次确认才能提交代码。
解决方式很简单：
将需要使用的非标准标记通过快速修复（Alt+Enter）添加为自定义标记即可。
当然这样做只对当前项目有效，对常用的自定义标记，最好在 Idea 的默认设置中进行添加，这样新项目也可以正确识别这些自定义标记。
The End.
文章评论