如何解决 At-clause should have a non-empty description？ - Checkstyle - Java

Question

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

我的java文档：

/**
   * 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

...并大致解释 为什么 会发生异常。

Answer 2

这是为文档中以“@”开头的每个参数显示的通用消息。因此，您需要为每个参数添加一些描述。

例如：

/**
     * Searches for top cars
     * @param carSearchRequest represents CarSearchRequest body
     * @param userId represents userid
     * @return CarsResponse
     * @throws Exception when userid is null
     */

Answer 3

为了快速处理这个问题以便我的构建不会因 checkstyle 而失败，我制作了一个 Eclipse code template 以在上下文 "Javadoc":

中使用

${word_selection}
   *           When ${word_selection} occurs.

Select异常的名字，按Ctrl+Space，选择"throws"（我给模板的名字），你就有了Checkstyle-legal comment:

* @throws IOException
*      When IOException occurs.

这是一个愚蠢的评论，但也是一个愚蠢的要求。

如何解决 At-clause should have a non-empty description？ - Checkstyle - Java

How to resolve At-clause should have a non-empty description? - Checkstyle - Java

java

checkstyle

google-style-guide