javadoc 주석이 비어있는 경우 Checkstyle을 구성하도록 도와 주시겠습니까?Checkstyle이 비어있는 javadoc 주석을 감지하지 못합니다
Checkstyle 이명 령은 (javadoc의 코멘트가 전혀없는) 다음과 같은 경우에 저를 경고하지 :
/**
*
*/
public enum MyType{ EQUALS }
나는 문서 here을 확인했지만, 나는이 문제를 관련 아무것도 볼 수 없었다.
이렇게하려면 섹션에 Style Javadoc Checkstyle 모듈을 사용할 수 있습니다. Checkstyle에서 documentation on Style Javadoc :
형식이 올바른지 확인하기 위해 Javadoc 주석의 유효성을 검사합니다. 다음 검사가 수행됩니다
- 첫 번째 문장이 올바른 문장 부호 (즉, 기본적으로, 기간, 물음표 또는 느낌표입니다)로 끝나는 보장합니다. Javadoc 은 메소드 요약 테이블 과 색인에 첫 번째 문장을 자동으로 배치합니다. 적절한 문장 부호가 없으면 Javadoc의 형식이 잘못되었을 수 있습니다. {@inheritDoc} 태그를 사용할 수있는 모든 항목은 요구 사항에서 면제됩니다.
- 설명이없는 Javadoc 문의 텍스트를 점검하십시오. 여기에는 완전히 비어있는 Javadoc과 @param 및 @return과 같은 태그가있는 Javadoc이 모두 포함됩니다.
확인 checkEmptyJavadoc 확인란 확인하십시오 :
글쎄, 당신은이를 확인하기 위해 Checkstyle 구성한? 어떤 수표가 방아쇠를 당길 기대합니까? –
설명서를 확인했지만이 문제와 관련된 내용을 볼 수 없습니다. 설정 파일에 어떤 속성을 설정해야하는지 잘 모르겠습니다. – zappee
누락 된 것이 아니라 비어 있습니다. –