添加行@throws java.io.IOException有什么用?

时间:2016-03-13 06:19:39

标签: java netbeans

使用throws IOException时,NetBeans会显示警告,其中需要添加行@throws java.io.IOException。这条线的用途是什么,这种方式使用它是不错的做法?

1 个答案:

答案 0 :(得分:5)

您可以使用@throws java.io.IOException对您的方法发表评论,并使用JavaDoc生成HTML文档。在本文档中,您可以看到此方法可能会抛出java.io.IOException

例如:

/**
* Method doing something
* 
* @param param1 - for something
*
* @throws {@link java.io.IOException} in some circumstance
*/

没有必要,但是好的做法是,像这样记录你的代码。对于非检查的运行时异常(例如IllegalArgumentException)执行此操作也是一种很好的做法,即使您通常不在throws子句中列出它们。

如果你像这样记录你的代码,你可以在IDE中使用Intellij IDEA中的'快速文档查找'或在Eclipse中的方法上悬停时看到格式良好的注释。

真实的例子:

@throws java.io.IOException example