Javadoc和RuntimeException

时间:2013-05-26 07:26:36

标签: java exception javadoc

我很好奇是否应该在方法签名后添加throws ExceptionClass。(ExceptionClass扩展RuntimeException)

例如:

public void foo() // throws ExceptionClass
{
    // ...
    throw new ExceptionClass("");
}

3 个答案:

答案 0 :(得分:6)

如果使用JDK作为指导,则RuntimeException不在方法签名中,而是在javadoc中记录。例如,您可以查看集合。

答案 1 :(得分:1)

理想情况下,您不需要在方法的throws子句中添加运行时异常。既然你希望这个方法的使用者知道这个方法可能抛出异常的可能性,我会说使用javadoc。以下是您应该如何使用的示例:

/**
 * 
 * @throws ExceptionClass
 */
public void foo()
{
    // ...
    throw new ExceptionClass("");
}

答案 2 :(得分:0)

运行时异常不需要在throws子句中列出。只有当你需要记录这种行为时才把它放在那里,如果它对某个类的客户知道某些重要的事情,可能会出现这种异常(但如果是这样,也许它需要要更改为已检查的异常,或仅在javadocs中提及。