javadoc을 구문 분석 할 때 체크 스타일 오류가 발생했습니다.

Question

기존 코드베이스에서 javadocs의 checkStyle 검사를 천천히 시도하려고합니다.

목록, 맵 등을 설명하는 매개 변수 (@param 또는 @return)가 발생할 때마다 나타나는 것처럼 보입니다. 코드를 구문 분석하지 못하고 오류가 발생합니다. 누구도이를 방지하는 방법을 모릅니다. ??

예를 들어

: 그것은

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

을 구문 분석 할 수

그래서

/** 
    * 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 {} 

오류 생성 : 다른 검사를 적용 할 때이 문제가 발생

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은/수행 수표를 통과해야합니다.

도움 당신은 아마 < 및 >처럼, XML 태그로 간주되지 않도록 < 및 >을 탈출해야합니다 :)

Answer 1

Javadoc specification에 따르면 @return에는 반환 값의 유형이 포함되어 있지 않습니다. @return 뒤에 반환되는 내용에 대한 설명을 추가하기 만하면됩니다. 유형을 포함하려면 설명의 일부이므로 <과 같은 HTML 문자를 이스케이프해야합니다 (>). 더 좋은 옵션이 될 것 같은 뭔가 :

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

(당신은 매개 변수 유형에 링크 할 수는 없지만 대신 제네릭 형식과 매개 변수 유형 모두에 연결해야합니다).

Answer 2

좋은 것입니다. 이 질문도 참조하십시오 How can I use "<" and ">" in javadoc without formatting?