StandardDoclet

StandardDoclet (표준 HTML 문서 생성 독렛)

지정된 모듈·패키지·타입에 대해 HTML 형식의 문서를 생성하는 표준 독렛입니다. Doclet 인터페이스를 직접 구현하며 사용자 정의 태그렛(taglet)을 지원합니다.

출처: Java API Reference

본문

StandardDoclet은 javadoc의 기본 동작을 담당하는 독렛으로, 지정된 모듈·패키지·타입에 대한 HTML 문서를 생성합니다. Doclet 인터페이스를 직접 구현합니다.

이 독렛은 문서 주석에서 사용자 정의 태그를 처리하기 위한 사용자 정의 태그렛을 지원합니다. 표준 독렛이 호출하는 태그렛은 Taglet.toString 결과로 문자열을 반환해야 하는데, 다음과 같은 규칙이 있습니다.

인라인 태그(Inline Tags)로 사용되는 경우 반환 문자열은 flow content이거나 문서 본문에 나타날 수 있는 유효한 HTML 코드 조각이어야 합니다. 태그가 문서 주석에서 어떻게 사용되느냐에 따라 추가 제약이 있을 수 있습니다. 예를 들어 인라인 요소 안에서 사용된다면 그 규칙을 따라야 합니다.

복잡한 문서 요구사항을 가진 프로젝트에서는 StandardDoclet을 상속·확장하거나 태그렛을 추가해 문서 생성을 커스터마이즈합니다.

더 알아보기 (Learn more)

Java 공식 API