如何修复Javadoc注释解析错误:解析JAVADOC_TAG时'*'无可行替代项报错
错误具体诱因
该报错是Javadoc解析器检测到标签语法不符合规范触发的,核心原因有两个:
- 异常声明标签拼写错误:Java Javadoc标准的异常声明标签是
@throws,你写的@throw拼写缺了末尾的s,属于非标准自定义标签,解析器无法识别该标签的语法结构。 - 标签内容为空:你代码中的
@return标签后没有填写任何返回值描述,直接换行到下一行标签,Javadoc规范要求@param、@return、@throws这类功能性标签后必须跟随非空的描述内容,空标签同样会触发NonEmptyAtClauseDescription类的解析错误。
修复方案
按照Javadoc规范修正两处问题即可:
- 将拼写错误的
@throw替换为标准标签@throws - 处理空的
@return标签:如果方法有返回值,补全对应的返回值说明;如果方法是void无返回值,直接删除空的@return标签即可。
正确示例代码
有返回值的场景
/** * This method is used for ABC. * @return 方法执行后返回的对应业务结果 * @throws IOException 发生IO异常时触发 */
无返回值(void)的场景
/** * This method is used for ABC. * @throws IOException 发生IO异常时触发 */
内容的提问来源于stack exchange,提问作者Charu
相关产品推荐
相关产品推荐

