Doclet

Doclet (독렛 사용자 구현 인터페이스)

사용자 독렛(doclet)이 반드시 구현해야 하는 인터페이스입니다. 각 Doclet 구현은 도구가 인스턴스화할 수 있도록 공개 무인자 생성자를 제공해야 합니다.

출처: Java API Reference

본문

Doclet은 javadoc 도구와 연동하여 문서 생성을 커스터마이즈하는 독렛이 구현해야 하는 인터페이스입니다. 각 구현은 도구가 독렛을 인스턴스화하는 데 사용하는 공개 무인자 생성자를 제공해야 합니다.

도구 인프라는 이 인터페이스를 구현하는 클래스와 다음과 같이 상호작용합니다. 먼저 독렛 클래스의 무인자 생성자로 인스턴스를 만들고, 다음으로 적절한 locale과 Reporter를 사용해 init 메서드를 호출합니다. 이후 getSupportedOptionsgetSupportedSourceVersion을 호출합니다. 이 메서드들은 한 번만 호출됩니다.

그다음 상황에 맞게 독렛 객체의 run 메서드를 호출하며, 여기에는 DocletEnvironment 객체가 주어져 독렛이 문서화할 요소(elements)를 결정할 수 있습니다. StandardDoclet이 이 인터페이스의 표준 구현을 제공합니다.

더 알아보기 (Learn more)

Java 공식 API