java - Javadoc 和 RuntimeException

Question

我很好奇是否应该throws ExceptionClass在方法签名之后添加。（ExceptionClass extends RuntimeException）

例如：

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

Answer 1

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

Answer 2

理想情况下，您不需要在方法的 throws 子句中添加运行时异常。由于您希望此方法的使用者意识到此方法可能引发异常的可能性，我会说也使用 javadoc。以下是您应该如何使用的示例：

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

Answer 3

运行时异常不需要在throws子句中列出。仅当您需要记录此行为时才将其放在那里，如果对于此类的客户来说知道在某种程度上很重要，则可能会出现此异常（但如果是这种情况，也许需要将其更改为已检查异常，或仅在 javadocs 中提及）。