使用Eclipse时Javadoc@param标签报错的原因及疑问

可能的原因及修复步骤 #

• 确认Javadoc注释格式正确
  必须使用/** ... */的文档注释包裹@param标签，而非普通的/* ... */注释。正确示例：

  /**
   * 初始化游戏棋盘
   * @param board 要初始化的棋盘对象
   */
  public void initBoard(Board board) {
      // 业务逻辑
  }
  

  若用普通注释，Eclipse无法识别为Javadoc语法，会把@param判定为错误内容。

• 检查Eclipse的Javadoc验证规则

  1. 打开Window > Preferences
  2. 依次展开Java > Compiler > Javadoc
  3. 确保Enable Javadoc comment validation处于勾选状态，同时检查下方规则是否误设了@param的格式要求（比如强制@param后无空格）
  4. 若有自定义规则，点击Restore Defaults恢复默认设置

• 核对项目JDK兼容性

  1. 右键项目选择Properties > Java Build Path
  2. 在Libraries标签页确认使用的JDK版本（JDK8及以上均支持标准Javadoc语法）
  3. 同步Java Compiler标签页的Compiler compliance level与JDK版本一致

• 清理重建项目
  Eclipse缓存异常可能导致错误提示混乱，执行以下操作：

  • 点击Project > Clean，选择当前项目清理
  • 右键项目选择Refresh刷新
  • 重新编译项目（Project > Build Project）

• 排查冲突插件
  若近期安装了代码注释、Javadoc类第三方插件，可能干扰Eclipse默认识别逻辑。尝试禁用这类插件后重启Eclipse，观察问题是否解决。

内容的提问来源于stack exchange，提问作者Heracless123