如何解决At-clause应该有一个非空的描述？ - Checkstyle - Java

Question

我在eclipse luna的checkstyle插件中使用了谷歌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

......并且通常解释为什么会发生这种例外.