Question

我有以下通用类型的方法，但是当我运行maven checkstyle（maven-checkstyle-plugin，2.121）时在maven构建期间，keep会给我Expected @param tag for '<T>'错误消息。我该如何克服这个？

/**
 * Read in specified type of object from request body.
 * @param request The HttpServletRequest
 * @param expected The expected type T
 * @return <T> specified type of object
 */
public <T extends Object> T getExpectedValue(
    final HttpServletRequest request, final Class<T> expected)

我使用了以下来关闭通用param标签，但它没有用，我也有上面提到的java文档。

<module name="JavadocType">
    <property name="allowMissingParamTags" value="true"/>
</module>

Answer 1

它告诉您没有为方法类型参数编写javadoc：

/**
 * ...
 * @param <T> This is the type parameter
 * @param ....
 */
 public <T extends Object> T getExpectedValue(
        final HttpServletRequest request, final Class<T> expected)

生成的javadoc将在标题中包含以下部分：

Type Parameters: 
    T - This is the type parameter

Answer 2

您将T的@param标记添加到您的Javadoc。

这样的事情：

/**
 * ... other comments here ...
 * @param T The expected class of the value.
 * @param request ... other comments here ...
 * @param expected ... other comments here ...
 * @return ... other comments here ...
 */
public <T extends Object> T getExpectedValue(
    final HttpServletRequest request, final Class<T> expected)

如果不是使用Javadoc，那么您可能不应该启用Javadoc警告。

Maven checkstyle错误：'<t>'的@param标记

2 个答案: