Javadoc，Eclipse 中的 "exception not thrown"

Question

创建 javaodc 时，您描述了您的方法可以抛出的异常，对吗？

看例子:

public  void createLogFile() {
    try {
        file.createNewFile();
        fileWriter = new FileWriter(file);
        bufferedWriter = new BufferedWriter(fileWriter);

    } catch (IOException e) {
        MainScene.ausgabeText.setText("Fehler bei dem Erstellen des Log Files.");

    }
}

这是我的这个方法的 javadoc。

/**
 * A logfile will be created
 * @exception IOException
 *                When the log file coulndt be created ( just a test :-))
 */

当导出到 javadoc 时，Eclipse 告诉我:

error: exception not thrown: java.io.IOException
 * @exception IOException

但 Eclipse 要我捕获该异常。

为什么我的 Eclipse 会给我上面的错误消息？

Answer 1

当您编写一个方法时，其实现对调用者是隐藏的(请忽略如果您自己编写方法实现则可以看到的事实)。有时在您实现一个方法时，您会遇到异常(或者您甚至可能会抛出自定义异常)。您可以做两件事:

捕获

当您想要处理异常时，您可以捕获它。这意味着您知道某些事情可能会出错，并且您知道该怎么做，以便在发生这种情况时程序可以以可预测的方式继续。

由于调用者看不到您的实现，因此对他们来说是完全隐藏的。

throw

当您不想处理异常时，因为它更适合让调用者意识到这个问题并进行处理。在这种情况下，您不会catch 它并通过throws 关键字将Exception 添加到方法中。当您这样做时，您可以在方法 Javadoc 中添加一个 @throws 或 @exception 注释，以准确地告诉调用者他们期望什么时候接收特定异常。

由于该注释仅用于告诉调用者何时期望以及如何正确处理该方法抛出的异常，因此添加该方法未抛出的任何异常是没有意义的。

请注意，您只需要throws 检查异常。方法不需要通过 throws 列出未经检查的异常，因为它们通常是由编写不当的代码引起的。