ошибка проверки стиля при разборе javadoc

Question

Я медленно пытаюсь ввести проверки CheckStyle для javadocs в существующую базу кода.

Похоже, каждый раз, когда он сталкивается с параметром (@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} 

(Вы не можете связаться с параметризованных типов, но вместо этого должен ссылаться как общего типа и типа параметра).

Answer 2

Вы должны, вероятно, избежать < и >, так что он не считается XML-тег, как < и >. См. Также этот вопрос How can I use "<" and ">" in javadoc without formatting?