2015-05-14 15 views
11

Mam następującą metodę z typów generycznych, ale gdy uruchamiam Checkstyle maven (Maven-Checkstyle-plugin, 2.121) to przechowywane daje mi komunikat o błędzie podczas Expected @param tag for '<T>' maven kompilacji. Jak mam się z tym pogodzić?błąd Maven Checkstyle: Oczekiwany tag @param dla '<T>'

Użyłem następujących po włączeniu ogólnego znacznika param, ale to nie zadziałało i mam wyżej wspomniany dokument java.

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

Wiesz to ostrzeżenie Javadoc, prawda? Mówi się, że nie masz Javadoc dla T. – immibis

+0

Jeśli chcesz wyłączyć allowMissingParamTags, musisz użyć modułu JavadocMethod zamiast JavadocType. Dokument: http://checkstyle.sourceforge.net/config_javadoc.html – zappee

Odpowiedz

11

jest informacją, że nie napisać javadoc dla parametru typu metoda:

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

wytworzony javadoc będzie zawierać sekcję jak następuje w nagłówku:

Type Parameters: 
    T - This is the type parameter 
+1

ale nie ma linii sugeruję, aby dodać w mojej odpowiedzi –

+0

Czy muszę dodatkowo dodać dokument java lub wymienić linię, którą mam? Czy możesz dać mi znać, która linia jest zła? – user2482822

+1

nie masz złych linii, to dodatkowo; jest to dokumentacja parametru typu metody, która uzupełnia dokument z argumentami i zwrotem (który już masz). –

3

Dodajesz znacznik @param do swojej Javadoc.

coś takiego:

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

Jeśli nie są użyciu Javadoc, to prawdopodobnie nie powinien mieć Javadoc ostrzeżenia włączone.

+0

Czy mógłbyś sprawdzić mój dokument java, który miałem? – user2482822

Powiązane problemy