生成Javadoc时报错:未知可抛出类型WrongFormatException求助
解决Javadoc生成时“Unknown throwable”报错问题
报错信息:Unknown throwable @throws pl.sydygaliev.java_journey.model.exception.WrongFormatException
以下是针对该问题的具体排查和解决步骤:
1. 修正方法签名,添加异常声明
你的handleKeyword方法Javadoc中使用了@throws注解,但方法本身并未声明抛出WrongFormatException(这是一个受检异常)。Javadoc要求@throws必须对应方法签名中显式声明的异常,否则会触发报错。
修改后的方法签名:
/** * The method that is used to handle given keyword. * If keyword has illegal values, it returns null. * @param keyword is used for keyword validation * @return keyword with given value or null if keyword * has unacceptable characters * @throws WrongFormatException when there is unacceptable * character for the keyword */ public String handleKeyword(String keyword) throws WrongFormatException { // 方法实现 }
2. 确保异常类已正确导入
在InitialHandlerAndStorer类顶部,添加异常类的导入语句:
import pl.sydygaliev.java_journey.model.exception.WrongFormatException;
如果未导入,Javadoc解析器无法识别未限定类名的WrongFormatException,会认为这是未知的异常类型。
3. 检查Javadoc生成的类路径配置
如果使用命令行生成Javadoc,需确保-sourcepath或-classpath参数包含WrongFormatException所在的源文件或类文件路径。例如:
javadoc -sourcepath src/pl/sydygaliev/java_journey/model/exception:src/pl/sydygaliev/java_journey/handler -d docs pl.sydygaliev.java_journey.handler.InitialHandlerAndStorer
如果使用IDE(如IntelliJ/Eclipse)生成Javadoc,需在生成配置中确保异常类所在的模块/包被包含在源路径中。
4. 验证异常类的可访问性
确认WrongFormatException的包结构和访问修饰符正确:
- 异常类是
public修饰(你的代码已满足),确保其他包的类可以访问它。 - 包路径
pl.sydygaliev.java_journey.model.exception与InitialHandlerAndStorer所在包(根据截图推测是pl.sydygaliev.java_journey.handler)的层级关系正确,没有路径拼写错误。
内容的提问来源于stack exchange,提问作者Aitsuken
相关产品推荐
相关产品推荐

