You need to enable JavaScript to run this app. Javadoc {@value}标签应用于常量时不生效报错问题排查
优惠活动
大模型
产品
解决方案
定价
更多

Javadoc {@value}标签应用于常量时不生效报错问题排查

Javadoc {@value} 标签生成报错排查

复现的代码与报错现象

为类内常量编写配套Javadoc注释时,在注释行使用{@value}标签自动填充常量值,代码编写完全对照标签使用规范完成,对应代码片段如下:

private final String playerName;

/**
 * The value of MAX_PLAYER_HEALTH is {@value} 
 */
private static final Integer MAX_PLAYER_HEALTH = 200;

/**
 * The value of DEFAULT_PLAYER_LIVES {@value}
 */
private static final Integer DEFAULT_PLAYER_LIVES = 3;

private Integer health = MAX_PLAYER_HEALTH;
private int lives = DEFAULT_PLAYER_LIVES;

执行Javadoc文档生成流程时,控制台输出两处明确报错:

PlayerSingleton.java: 对应MAX_PLAYER_HEALTH注释行: error: {@value} not allowed here
PlayerSingleton.java: 对应DEFAULT_PLAYER_LIVES注释行: error: {@value} not allowed here

问题根本原因

Javadoc工具对{@value}标签的解析存在严格的类型限制:

  • 该标签仅支持直接引用编译期可确定的基本数据类型常量、字符串常量的字面量值
  • 当常量类型为Integer这类包装引用类型时,即便常量值在编译阶段即可确定,工具也不会将其识别为可被{@value}解析的内联常量,直接判定标签使用位置不合法并抛出报错

验证可行的解决方法

将包装类型的常量定义调整为对应的基本数据类型,即将原Integer类型的常量声明替换为int类型:

/**
 * The value of MAX_PLAYER_HEALTH is {@value} 
 */
private static final int MAX_PLAYER_HEALTH = 200;

/**
 * The value of DEFAULT_PLAYER_LIVES {@value}
 */
private static final int DEFAULT_PLAYER_LIVES = 3;

调整完成后重新执行Javadoc生成操作,工具可正常解析{@value}标签,不会再抛出格式错误。

内容的提问来源于stack exchange,提问作者AMhere

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.09 04:24:08