Ошибка проверки Maven: ожидаемый тег @param для '<T>'
У меня есть следующий метод с общими типами, но когда я запускаю maven checkstyle (maven-checkstyle-plugin, 2.121), он
поддерживается сообщение об ошибке Expected @param tag for '<T>'
во время сборки maven. Как мне с этим справиться?
/**
* 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>
Ответы
Ответ 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
Ответ 2
Вы добавляете тег @param
для T в свой 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.