Javadoc和RuntimeException

Question

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

例如：

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

Answer 1

理想情况下，你不需要在方法的throws子句中添加运行时异常。由于您希望此方法的使用者意识到此方法可能抛出异常，因此我建议您也使用javadoc。下面是您应该如何使用的示例：

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

Answer 2

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

Answer 3

运行时异常不需要在throws子句中列出。只有当你需要记录这种行为的时候，如果在某种程度上对这个类的客户端来说很重要，知道这个异常可能会出现(但如果是这样的话，可能需要将它更改为一个检查异常，或者只在javadoc中提到)，才把它放在那里。