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

Question

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

Answer 1

您可以使用@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子句中列出它们)也可以这样做.

如果您像这样记录代码,那么在Intellij IDEA中使用"快速文档查找"时,您可以在IDE中看到格式良好的注释,或者将鼠标悬停在Eclipse中的方法上.

真实的例子: