Javadoc-Comments에서 놓친 것이있을 때 Javadoc으로부터 경고를받을 수 있습니까?

문제

실수로 방법이나 클래스 등을 문서화 할 때 일부 매개 변수 또는 예외 던지기 (또는 다른)를 설명하는 것을 잊을 수 있습니다.

누락 된 문서 항목에 대해 경고하는 방식으로 Javadoc을 실행할 수 있습니까?

(문서를 생성하기 위해 개미 스크립트를 사용합니다)

해결책

사용 체크 스타일! 그것은 ANTER ANT 통합을 가지고 있으며 소스 코드에 대한 다른 중요한 검사의 100 개를 지원합니다.

그만큼 Javadoctype Checker 그래도 필요한 것입니다.

다른 팁

문서화되지 않은 품목에 대한 경고를 발행하는 Javadoc 옵션은 모릅니다.

그러나 Eclipse를 사용하면 설정을 살펴보십시오.

창 -> 환경 설정 -> java-> 컴파일러 -> javadoc

여기에서 Eclipse에 문서화되지 않은 품목에 대한 경고를 발행하도록 알 수 있습니다.

우리는 사용했었다 Doc Check Doclet 이전 프로젝트의 경우. 빌드와 통합 될 수 있으며 문서가 열악한 코드를 알려주는 유용한 보고서를 생성합니다.

참고 :이 도구는 베타이며 더 이상 Sun에서 지원하지 않습니다.

예, 일식에서 당신은 당신이 정의하는 모든 것에 대한 점검을 통합 한 것이므로, 이것을 "경고"에 놓을 수 있으며 실수를하는 곳을 볼 수있는 것보다 더 많이 놓을 수 있습니다.

라이센스 : CC-BY-SA ~와 함께 속성

제휴하지 않습니다 StackOverflow