java - 如何解决 At-clause should have a non-empty description？ - 检查样式 - Java

Question

我在 eclipse luna 的 checkstyle 插件中使用 google java 样式。在我的 java 文档中看到此错误，但似乎无法找到解决方法。它很小，但它困扰着我。

我的 javadoc:

/**
   * This is a description of something
   * 
   * @throws Exception
   */

错误在@throws 行，错误:

At-clause should have a non-empty description

Answer 1

通常，你应该写

 * @throws Exception when this exceptional condition happens

例如

 * @throws IllegalArgumentException when num is negative

...并一般性地解释为什么会发生该异常。