如何解决 At-clause 应该有一个非空的描述？ - 检查样式 - Java

Posted 2023-02-26

【中文标题】如何解决 At-clause 应该有一个非空的描述？ - 检查样式 - Java

【英文标题】：How to resolve At-clause should have a non-empty description? - Checkstyle - Java

【发布时间】：2016-01-07 18:05:40

【问题描述】：

我在 eclipse luna 的 checkstyle 插件中使用 google java 样式。在我的 java 文档中看到这个错误，但似乎找不到解决方法。这是次要的，但它困扰着我。

我的 javadoc：

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

错误出现在@throws 行，错误：

At-clause should have a non-empty description

【参考方案1】：

通常，你应该写

 * @throws Exception when this exceptional condition happens

例如

 * @throws IllegalArgumentException when num is negative

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

【参考方案2】：

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

例如：

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

【参考方案3】：

为了解决这个问题，我的构建不会因 checkstyle 而失败，我创建了一个 Eclipse code template 以在上下文“Javadoc”中使用：

$word_selection
   *           When $word_selection occurs.

选择异常的名称，按Ctrl+Space，选择“throws”（我给模板起的名字），你就有了Checkstyle-legal注释：

* @throws IOException
*      When IOException occurs.

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