java - 解析javadoc时检查样式错误

Question

我正在慢慢尝试在现有代码库中引入 checkStyle 检查 javadoc。

好像每次遇到描述list、map等的参数(@param或@return)，都无法解析代码并抛出错误，有人知道如何防止这种情况吗？

例如:

  /**
   * Process list of people.
   *
   * @param account the relevant account.
   * @return List<People> the people we are interested in.
   * @throws SQLException
   */
   private static List<People> getPeople(Account account) throws SQLException {}

所以它无法解析

* @return List<People> the people we are interested in.

并产生错误:

error: Javadoc comment at column 18 has parse error. Missed HTML close tag 'People'. Sometimes it means that close tag missed for one of previous tags.

当尝试应用不同的检查并且此 jdoc 确实/应该通过检查时会发生这种情况。

任何帮助都会很棒 :)

Answer 1

根据 Javadoc specification , @return不包括返回值的类型。您只需在 @return 之后添加对返回内容的描述.如果你想包括类型，它是描述的一部分，因此是 HTML 字符，如 <需要转义(>)。更好的选择是这样的:

@return {@link List} of {@link People}

(您不能链接到参数化类型，而应该同时链接到泛型类型和参数类型)。